webengine/osswebengine/WebKit/s60/webview/webview_api_test/inc/BrCtlInterface.h
branchRCL_3
changeset 94 919f36ff910f
parent 93 79859ed3eea9
equal deleted inserted replaced
93:79859ed3eea9 94:919f36ff910f
    13 *
    13 *
    14 * Description:   Definition of the Browser Control API - webview_api_test
    14 * Description:   Definition of the Browser Control API - webview_api_test
    15 *
    15 *
    16 */
    16 */
    17 
    17 
    18 
       
    19 
       
    20 #ifndef BRCTLINTERFACE_H
    18 #ifndef BRCTLINTERFACE_H
    21 #define BRCTLINTERFACE_H
    19 #define BRCTLINTERFACE_H
    22 
    20 
    23 //  INCLUDES
    21 //  INCLUDES
    24 #include <../bidi.h>
    22 #include <../bidi.h>
    26 #include <e32base.h>
    24 #include <e32base.h>
    27 #include <coecntrl.h>
    25 #include <coecntrl.h>
    28 #include <eikmenup.h>
    26 #include <eikmenup.h>
    29 #include <ssl.h>
    27 #include <ssl.h>
    30 
    28 
    31 #include <BrCtlDialogsProvider.h>
    29 #include <brctldialogsprovider.h>
    32 #include <BrCtlLayoutObserver.h>
    30 #include <brctllayoutobserver.h>
    33 #include <BrCtlLinkResolver.h>
    31 #include <brctllinkresolver.h>
    34 #include <BrCtlSoftkeysObserver.h>
    32 #include <brctlsoftkeysobserver.h>
    35 #include <BrCtlSpecialLoadObserver.h>
    33 #include <brctlspecialloadobserver.h>
    36 #include <BrCtlWindowObserver.h>
    34 #include <brctlwindowobserver.h>
    37 #include <BrCtlDownloadObserver.h>
    35 #include <brctldownloadobserver.h>
    38 #include <BrCtlDefs.h>
    36 #include <brctldefs.h>
    39 
    37 
    40 // DATA TYPES
    38 // DATA TYPES
    41 
    39 
    42 // FORWARD DECLARATIONS
    40 // FORWARD DECLARATIONS
    43 class MBrCtlDataLoadSupplier;
    41 class MBrCtlDataLoadSupplier;
   107 * MBrCtlDialogsProvider etc.
   105 * MBrCtlDialogsProvider etc.
   108 *
   106 *
   109 * Usage:
   107 * Usage:
   110 *
   108 *
   111 * @code
   109 * @code
   112 *  #include <BrCtlInterface.h>
   110 *  #include <brctlinterface.h>
   113 *  // Interface that provides dialogs used by the Browser Control.
   111 *  // Interface that provides dialogs used by the Browser Control.
   114 *  #include <BrCtlDialogsProvider.h>
   112 *  #include <brctldialogsprovider.h>
   115 *  // Interface used to receive scrolling events.
   113 *  // Interface used to receive scrolling events.
   116 *  #include <BrCtlLayoutObserver.h>
   114 *  #include <brctllayoutobserver.h>
   117 *  //Interface that provides a callback mechanism for receiving the
   115 *  //Interface that provides a callback mechanism for receiving the
   118 *  //content of an embedded link or the content of a user-initiated
   116 *  //content of an embedded link or the content of a user-initiated
   119 *  //load request.
   117 *  //load request.
   120 *  #include <BrCtlLinkResolver.h>
   118 *  #include <brctllinkresolver.h>
   121 *  //Interface that handles requests to change the softkeys.
   119 *  //Interface that handles requests to change the softkeys.
   122 *  #include <BrCtlSoftkeysObserver.h>
   120 *  #include <brctlsoftkeysobserver.h>
   123 *  //Interface that handles special load needs.
   121 *  //Interface that handles special load needs.
   124 *  #include <BrCtlSpecialLoadObserver.h>
   122 *  #include <brctlspecialloadobserver.h>
   125 *  //Reserved for future use.
   123 *  //Reserved for future use.
   126 *  #include <BrCtlWindowObserver.h>
   124 *  #include <brctlwindowobserver.h>
   127 *  //Interface that passes download events from the
   125 *  //Interface that passes download events from the
   128 *  //Download Manager through the Browser Control to the
   126 *  //Download Manager through the Browser Control to the
   129 *  //host application.
   127 *  //host application.
   130 *  #include <BrCtlDownloadObserver.h>
   128 *  #include <brctldownloadobserver.h>
   131 *  Enum Definition of the Browser Control API.
   129 *  Enum Definition of the Browser Control API.
   132 *  #include <BrCtlDefs.h>
   130 *  #include <brctldefs.h>
   133 *
   131 *
   134 *
   132 *
   135 *   The following types of things you can do with the Browser Control API.
   133 *   The following types of things you can do with the Browser Control API.
   136 *
   134 *
   137 * Creating a basic Browser Control
   135 * Creating a basic Browser Control
   147 * Receiving change-of-state events
   145 * Receiving change-of-state events
   148 *
   146 *
   149 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   147 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   150 * @lib BrowserEngine.lib
   148 * @lib BrowserEngine.lib
   151 * @since 2.8
   149 * @since 2.8
   152 * @file BrCtlInterface.h
   150 * @file brctlinterface.h
   153 * @endcode     *
   151 * @endcode     *
   154 */
   152 */
   155 class CBrCtlInterface : public CCoeControl
   153 class CBrCtlInterface : public CCoeControl
   156     {
   154     {
   157     public:  // Constructors and destructor
   155     public:  // Constructors and destructor
   617 * load operation, it can cancel that operation by means of this interface.
   615 * load operation, it can cancel that operation by means of this interface.
   618 *
   616 *
   619 * Usage:
   617 * Usage:
   620 *
   618 *
   621 * @code
   619 * @code
   622 *  #include <BrCtlInterface.h>
   620 *  #include <brctlinterface.h>
   623 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   621 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   624 * @lib BrowserEngine.lib
   622 * @lib BrowserEngine.lib
   625 * @since 2.8
   623 * @since 2.8
   626 * @file BrCtlInterface.h
   624 * @file brctlinterface.h
   627 * @endcode     *
   625 * @endcode     *
   628 */
   626 */
   629 class MBrCtlDataLoadSupplier
   627 class MBrCtlDataLoadSupplier
   630     {
   628     {
   631     public: // New functions
   629     public: // New functions
   642 /**
   640 /**
   643 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   641 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   644 * the Browser Control with the ability to receive content incrementally.
   642 * the Browser Control with the ability to receive content incrementally.
   645 *
   643 *
   646 * @code
   644 * @code
   647 *  #include <BrCtlInterface.h>
   645 *  #include <brctlinterface.h>
   648 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   646 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   649 * @lib BrowserEngine.lib
   647 * @lib BrowserEngine.lib
   650 * @since 2.8
   648 * @since 2.8
   651 * @file BrCtlInterface.h
   649 * @file brctlinterface.h
   652 * @endcode     *
   650 * @endcode     *
   653 */
   651 */
   654 class MBrCtlDataLoadConsumer
   652 class MBrCtlDataLoadConsumer
   655     {
   653     {
   656     public: // New functions
   654     public: // New functions
   682 /**
   680 /**
   683 * The MBrCtlLoadEventObserver interface receives load progress events.
   681 * The MBrCtlLoadEventObserver interface receives load progress events.
   684 * The host application can implement this interface.
   682 * The host application can implement this interface.
   685 *
   683 *
   686 * @code
   684 * @code
   687 *  #include <BrCtlInterface.h>
   685 *  #include <brctlinterface.h>
   688 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   686 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   689 * @lib BrowserEngine.lib
   687 * @lib BrowserEngine.lib
   690 * @since 2.8
   688 * @since 2.8
   691 * @file BrCtlInterface.h
   689 * @file brctlinterface.h
   692 * @endcode     *
   690 * @endcode     *
   693 */
   691 */
   694 class MBrCtlLoadEventObserver
   692 class MBrCtlLoadEventObserver
   695     {
   693     {
   696     public: // New functions
   694     public: // New functions
   707 
   705 
   708 /**
   706 /**
   709 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   707 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   710 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   708 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   711 * @code
   709 * @code
   712 *  #include <BrCtlInterface.h>
   710 *  #include <brctlinterface.h>
   713 * @lib BrowserEngine.lib
   711 * @lib BrowserEngine.lib
   714 * @since 2.8
   712 * @since 2.8
   715 * @file BrCtlInterface.h
   713 * @file brctlinterface.h
   716 * @endcode     *
   714 * @endcode     *
   717 */
   715 */
   718 class TBrCtlWmlServiceOption
   716 class TBrCtlWmlServiceOption
   719     {
   717     {
   720     public:
   718     public:
   769     };
   767     };
   770 
   768 
   771 /**
   769 /**
   772 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   770 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   773 * @code
   771 * @code
   774 *  #include <BrCtlInterface.h>
   772 *  #include <brctlinterface.h>
   775 * @lib BrowserEngine.lib
   773 * @lib BrowserEngine.lib
   776 * @since 2.8
   774 * @since 2.8
   777 * @file BrCtlInterface.h
   775 * @file brctlinterface.h
   778 * @endcode     *
   776 * @endcode     *
   779 */
   777 */
   780 class TBrCtlSubscribeTo
   778 class TBrCtlSubscribeTo
   781     {
   779     {
   782     public:
   780     public:
   831 * the Image Map view. In Image Map view, only an image map is displayed,
   829 * the Image Map view. In Image Map view, only an image map is displayed,
   832 * which enables the user to navigate. The host application can
   830 * which enables the user to navigate. The host application can
   833 * implement this interface in order to find out when the view
   831 * implement this interface in order to find out when the view
   834 * changes to and from the Image Map view.
   832 * changes to and from the Image Map view.
   835 * @code
   833 * @code
   836 *  #include <BrCtlInterface.h>
   834 *  #include <brctlinterface.h>
   837 * @lib BrowserEngine.lib
   835 * @lib BrowserEngine.lib
   838 * @since 2.8
   836 * @since 2.8
   839 * @file BrCtlInterface.h
   837 * @file brctlinterface.h
   840 * @endcode     *
   838 * @endcode     *
   841 */
   839 */
   842 class MBrCtlStateChangeObserver
   840 class MBrCtlStateChangeObserver
   843     {
   841     {
   844     public:
   842     public: