web_pub/browser_control_api/inc/BrCtlInterface.h
changeset 25 0ed94ceaa377
parent 0 dd21522fd290
child 47 e1bea15f9a39
equal deleted inserted replaced
22:9a9a761f03f1 25:0ed94ceaa377
    25 #include <e32base.h>
    25 #include <e32base.h>
    26 #include <coecntrl.h>
    26 #include <coecntrl.h>
    27 #include <eikmenup.h>
    27 #include <eikmenup.h>
    28 #include <ssl.h>
    28 #include <ssl.h>
    29 
    29 
    30 #include <BrCtlDialogsProvider.h>
    30 #include <brctldialogsprovider.h>
    31 #include <BrCtlLayoutObserver.h>
    31 #include <brctllayoutobserver.h>
    32 #include <BrCtlLinkResolver.h>
    32 #include <brctllinkresolver.h>
    33 #include <BrCtlSoftkeysObserver.h>
    33 #include <brctlsoftkeysobserver.h>
    34 #include <BrCtlSpecialLoadObserver.h>
    34 #include <brctlspecialloadobserver.h>
    35 #include <BrCtlWindowObserver.h>
    35 #include <brctlwindowobserver.h>
    36 #include <BrCtlDownloadObserver.h>
    36 #include <brctldownloadobserver.h>
    37 #include <BrCtlDefs.h>
    37 #include <brctldefs.h>
    38 
    38 
    39 // DATA TYPES
    39 // DATA TYPES
    40 
    40 
    41 // FORWARD DECLARATIONS
    41 // FORWARD DECLARATIONS
    42 class MBrCtlDataLoadSupplier;
    42 class MBrCtlDataLoadSupplier;
   106 * MBrCtlDialogsProvider etc.
   106 * MBrCtlDialogsProvider etc.
   107 *
   107 *
   108 * Usage:
   108 * Usage:
   109 *
   109 *
   110 * @code
   110 * @code
   111 *  #include <BrCtlInterface.h>
   111 *  #include <brctlinterface.h>
   112 *  // Interface that provides dialogs used by the Browser Control.
   112 *  // Interface that provides dialogs used by the Browser Control.
   113 *  #include <BrCtlDialogsProvider.h>
   113 *  #include <brctldialogsprovider.h>
   114 *  // Interface used to receive scrolling events.
   114 *  // Interface used to receive scrolling events.
   115 *  #include <BrCtlLayoutObserver.h>
   115 *  #include <brctllayoutobserver.h>
   116 *  //Interface that provides a callback mechanism for receiving the
   116 *  //Interface that provides a callback mechanism for receiving the
   117 *  //content of an embedded link or the content of a user-initiated
   117 *  //content of an embedded link or the content of a user-initiated
   118 *  //load request.
   118 *  //load request.
   119 *  #include <BrCtlLinkResolver.h>
   119 *  #include <brctllinkresolver.h>
   120 *  //Interface that handles requests to change the softkeys.
   120 *  //Interface that handles requests to change the softkeys.
   121 *  #include <BrCtlSoftkeysObserver.h>
   121 *  #include <brctlsoftkeysobserver.h>
   122 *  //Interface that handles special load needs.
   122 *  //Interface that handles special load needs.
   123 *  #include <BrCtlSpecialLoadObserver.h>
   123 *  #include <brctlspecialloadobserver.h>
   124 *  //Reserved for future use.
   124 *  //Reserved for future use.
   125 *  #include <BrCtlWindowObserver.h>
   125 *  #include <brctlwindowobserver.h>
   126 *  //Interface that passes download events from the
   126 *  //Interface that passes download events from the
   127 *  //Download Manager through the Browser Control to the
   127 *  //Download Manager through the Browser Control to the
   128 *  //host application.
   128 *  //host application.
   129 *  #include <BrCtlDownloadObserver.h>
   129 *  #include <brctldownloadobserver.h>
   130 *  Enum Definition of the Browser Control API.
   130 *  Enum Definition of the Browser Control API.
   131 *  #include <BrCtlDefs.h>
   131 *  #include <brctldefs.h>
   132 *
   132 *
   133 *
   133 *
   134 *   The following types of things you can do with the Browser Control API.
   134 *   The following types of things you can do with the Browser Control API.
   135 *
   135 *
   136 * Creating a basic Browser Control
   136 * Creating a basic Browser Control
   146 * Receiving change-of-state events
   146 * Receiving change-of-state events
   147 *
   147 *
   148 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   148 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   149 * @lib BrowserEngine.lib
   149 * @lib BrowserEngine.lib
   150 * @since 2.8
   150 * @since 2.8
   151 * @file BrCtlInterface.h
   151 * @file brctlinterface.h
   152 * @endcode     *
   152 * @endcode     *
   153 */
   153 */
   154 class CBrCtlInterface : public CCoeControl
   154 class CBrCtlInterface : public CCoeControl
   155     {
   155     {
   156     public:  // Constructors and destructor
   156     public:  // Constructors and destructor
   623 * load operation, it can cancel that operation by means of this interface.
   623 * load operation, it can cancel that operation by means of this interface.
   624 *
   624 *
   625 * Usage:
   625 * Usage:
   626 *
   626 *
   627 * @code
   627 * @code
   628 *  #include <BrCtlInterface.h>
   628 *  #include <brctlinterface.h>
   629 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   629 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   630 * @lib BrowserEngine.lib
   630 * @lib BrowserEngine.lib
   631 * @since 2.8
   631 * @since 2.8
   632 * @file BrCtlInterface.h
   632 * @file brctlinterface.h
   633 * @endcode     *
   633 * @endcode     *
   634 */
   634 */
   635 class MBrCtlDataLoadSupplier
   635 class MBrCtlDataLoadSupplier
   636     {
   636     {
   637     public: // New functions
   637     public: // New functions
   648 /**
   648 /**
   649 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   649 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   650 * the Browser Control with the ability to receive content incrementally.
   650 * the Browser Control with the ability to receive content incrementally.
   651 *
   651 *
   652 * @code
   652 * @code
   653 *  #include <BrCtlInterface.h>
   653 *  #include <brctlinterface.h>
   654 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   654 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   655 * @lib BrowserEngine.lib
   655 * @lib BrowserEngine.lib
   656 * @since 2.8
   656 * @since 2.8
   657 * @file BrCtlInterface.h
   657 * @file brctlinterface.h
   658 * @endcode     *
   658 * @endcode     *
   659 */
   659 */
   660 class MBrCtlDataLoadConsumer
   660 class MBrCtlDataLoadConsumer
   661     {
   661     {
   662     public: // New functions
   662     public: // New functions
   688 /**
   688 /**
   689 * The MBrCtlLoadEventObserver interface receives load progress events.
   689 * The MBrCtlLoadEventObserver interface receives load progress events.
   690 * The host application can implement this interface.
   690 * The host application can implement this interface.
   691 *
   691 *
   692 * @code
   692 * @code
   693 *  #include <BrCtlInterface.h>
   693 *  #include <brctlinterface.h>
   694 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   694 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   695 * @lib BrowserEngine.lib
   695 * @lib BrowserEngine.lib
   696 * @since 2.8
   696 * @since 2.8
   697 * @file BrCtlInterface.h
   697 * @file brctlinterface.h
   698 * @endcode     *
   698 * @endcode     *
   699 */
   699 */
   700 class MBrCtlLoadEventObserver
   700 class MBrCtlLoadEventObserver
   701     {
   701     {
   702     public: // New functions
   702     public: // New functions
   713 
   713 
   714 /**
   714 /**
   715 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   715 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   716 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   716 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   717 * @code
   717 * @code
   718 *  #include <BrCtlInterface.h>
   718 *  #include <brctlinterface.h>
   719 * @lib BrowserEngine.lib
   719 * @lib BrowserEngine.lib
   720 * @since 2.8
   720 * @since 2.8
   721 * @file BrCtlInterface.h
   721 * @file brctlinterface.h
   722 * @endcode     *
   722 * @endcode     *
   723 */
   723 */
   724 class TBrCtlWmlServiceOption
   724 class TBrCtlWmlServiceOption
   725     {
   725     {
   726     public:
   726     public:
   775     };
   775     };
   776 
   776 
   777 /**
   777 /**
   778 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   778 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   779 * @code
   779 * @code
   780 *  #include <BrCtlInterface.h>
   780 *  #include <brctlinterface.h>
   781 * @lib BrowserEngine.lib
   781 * @lib BrowserEngine.lib
   782 * @since 2.8
   782 * @since 2.8
   783 * @file BrCtlInterface.h
   783 * @file brctlinterface.h
   784 * @endcode     *
   784 * @endcode     *
   785 */
   785 */
   786 class TBrCtlSubscribeTo
   786 class TBrCtlSubscribeTo
   787     {
   787     {
   788     public:
   788     public:
   837 * the Image Map view. In Image Map view, only an image map is displayed,
   837 * the Image Map view. In Image Map view, only an image map is displayed,
   838 * which enables the user to navigate. The host application can
   838 * which enables the user to navigate. The host application can
   839 * implement this interface in order to find out when the view
   839 * implement this interface in order to find out when the view
   840 * changes to and from the Image Map view.
   840 * changes to and from the Image Map view.
   841 * @code
   841 * @code
   842 *  #include <BrCtlInterface.h>
   842 *  #include <brctlinterface.h>
   843 * @lib BrowserEngine.lib
   843 * @lib BrowserEngine.lib
   844 * @since 2.8
   844 * @since 2.8
   845 * @file BrCtlInterface.h
   845 * @file brctlinterface.h
   846 * @endcode     *
   846 * @endcode     *
   847 */
   847 */
   848 class MBrCtlStateChangeObserver
   848 class MBrCtlStateChangeObserver
   849     {
   849     {
   850     public:
   850     public: