web_pub/browser_control_api/inc/BrCtlInterface.h
branchRCL_3
changeset 48 79859ed3eea9
parent 47 e1bea15f9a39
child 49 919f36ff910f
equal deleted inserted replaced
47:e1bea15f9a39 48:79859ed3eea9
    17 
    17 
    18 
    18 
    19 #ifndef BRCTLINTERFACE_H
    19 #ifndef BRCTLINTERFACE_H
    20 #define BRCTLINTERFACE_H
    20 #define BRCTLINTERFACE_H
    21 
    21 
       
    22 #warning The Browser Control API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information
       
    23 
    22 //  INCLUDES
    24 //  INCLUDES
    23 #include <../bidi.h>
    25 #include <../bidi.h>
    24 #include <e32std.h>
    26 #include <e32std.h>
    25 #include <e32base.h>
    27 #include <e32base.h>
    26 #include <coecntrl.h>
    28 #include <coecntrl.h>
    27 #include <eikmenup.h>
    29 #include <eikmenup.h>
    28 #include <ssl.h>
    30 #include <ssl.h>
    29 
    31 
    30 #include <brctldialogsprovider.h>
    32 #include <BrCtlDialogsProvider.h>
    31 #include <brctllayoutobserver.h>
    33 #include <BrCtlLayoutObserver.h>
    32 #include <brctllinkresolver.h>
    34 #include <BrCtlLinkResolver.h>
    33 #include <brctlsoftkeysobserver.h>
    35 #include <BrCtlSoftkeysObserver.h>
    34 #include <brctlspecialloadobserver.h>
    36 #include <BrCtlSpecialLoadObserver.h>
    35 #include <brctlwindowobserver.h>
    37 #include <BrCtlWindowObserver.h>
    36 #include <brctldownloadobserver.h>
    38 #include <BrCtlDownloadObserver.h>
    37 #include <brctldefs.h>
    39 #include <BrCtlDefs.h>
    38 
    40 
    39 // DATA TYPES
    41 // DATA TYPES
    40 
    42 
    41 // FORWARD DECLARATIONS
    43 // FORWARD DECLARATIONS
    42 class MBrCtlDataLoadSupplier;
    44 class MBrCtlDataLoadSupplier;
   106 * MBrCtlDialogsProvider etc.
   108 * MBrCtlDialogsProvider etc.
   107 *
   109 *
   108 * Usage:
   110 * Usage:
   109 *
   111 *
   110 * @code
   112 * @code
   111 *  #include <brctlinterface.h>
   113 *  #include <BrCtlInterface.h>
   112 *  // Interface that provides dialogs used by the Browser Control.
   114 *  // Interface that provides dialogs used by the Browser Control.
   113 *  #include <brctldialogsprovider.h>
   115 *  #include <BrCtlDialogsProvider.h>
   114 *  // Interface used to receive scrolling events.
   116 *  // Interface used to receive scrolling events.
   115 *  #include <brctllayoutobserver.h>
   117 *  #include <BrCtlLayoutObserver.h>
   116 *  //Interface that provides a callback mechanism for receiving the
   118 *  //Interface that provides a callback mechanism for receiving the
   117 *  //content of an embedded link or the content of a user-initiated
   119 *  //content of an embedded link or the content of a user-initiated
   118 *  //load request.
   120 *  //load request.
   119 *  #include <brctllinkresolver.h>
   121 *  #include <BrCtlLinkResolver.h>
   120 *  //Interface that handles requests to change the softkeys.
   122 *  //Interface that handles requests to change the softkeys.
   121 *  #include <brctlsoftkeysobserver.h>
   123 *  #include <BrCtlSoftkeysObserver.h>
   122 *  //Interface that handles special load needs.
   124 *  //Interface that handles special load needs.
   123 *  #include <brctlspecialloadobserver.h>
   125 *  #include <BrCtlSpecialLoadObserver.h>
   124 *  //Reserved for future use.
   126 *  //Reserved for future use.
   125 *  #include <brctlwindowobserver.h>
   127 *  #include <BrCtlWindowObserver.h>
   126 *  //Interface that passes download events from the
   128 *  //Interface that passes download events from the
   127 *  //Download Manager through the Browser Control to the
   129 *  //Download Manager through the Browser Control to the
   128 *  //host application.
   130 *  //host application.
   129 *  #include <brctldownloadobserver.h>
   131 *  #include <BrCtlDownloadObserver.h>
   130 *  Enum Definition of the Browser Control API.
   132 *  Enum Definition of the Browser Control API.
   131 *  #include <brctldefs.h>
   133 *  #include <BrCtlDefs.h>
   132 *
   134 *
   133 *
   135 *
   134 *   The following types of things you can do with the Browser Control API.
   136 *   The following types of things you can do with the Browser Control API.
   135 *
   137 *
   136 * Creating a basic Browser Control
   138 * Creating a basic Browser Control
   146 * Receiving change-of-state events
   148 * Receiving change-of-state events
   147 *
   149 *
   148 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   150 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   149 * @lib BrowserEngine.lib
   151 * @lib BrowserEngine.lib
   150 * @since 2.8
   152 * @since 2.8
   151 * @file brctlinterface.h
   153 * @file BrCtlInterface.h
   152 * @endcode     *
   154 * @endcode     *
   153 */
   155 */
   154 class CBrCtlInterface : public CCoeControl
   156 class CBrCtlInterface : public CCoeControl
   155     {
   157     {
   156     public:  // Constructors and destructor
   158     public:  // Constructors and destructor
   609         * @since 5.0
   611         * @since 5.0
   610         * @ fills offscreen bitmap.The bitmap memory has to be set and freed by the api calling that function.
   612         * @ fills offscreen bitmap.The bitmap memory has to be set and freed by the api calling that function.
   611         * @return void. 
   613         * @return void. 
   612         */
   614         */
   613         IMPORT_C virtual void TakeSnapshotL(CFbsBitmap& snapshot) = 0; 
   615         IMPORT_C virtual void TakeSnapshotL(CFbsBitmap& snapshot) = 0; 
   614         
       
   615         IMPORT_C virtual TBool IsSynchRequestPending()= 0 ;
       
   616     };
   616     };
   617 
   617 
   618 
   618 
   619 /**
   619 /**
   620 * The MBrCtlDataLoadSupplier class is a callback interface that
   620 * The MBrCtlDataLoadSupplier class is a callback interface that
   625 * load operation, it can cancel that operation by means of this interface.
   625 * load operation, it can cancel that operation by means of this interface.
   626 *
   626 *
   627 * Usage:
   627 * Usage:
   628 *
   628 *
   629 * @code
   629 * @code
   630 *  #include <brctlinterface.h>
   630 *  #include <BrCtlInterface.h>
   631 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   631 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   632 * @lib BrowserEngine.lib
   632 * @lib BrowserEngine.lib
   633 * @since 2.8
   633 * @since 2.8
   634 * @file brctlinterface.h
   634 * @file BrCtlInterface.h
   635 * @endcode     *
   635 * @endcode     *
   636 */
   636 */
   637 class MBrCtlDataLoadSupplier
   637 class MBrCtlDataLoadSupplier
   638     {
   638     {
   639     public: // New functions
   639     public: // New functions
   650 /**
   650 /**
   651 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   651 * The MBrCtlDataLoadConsumer class is a callback interface that provides
   652 * the Browser Control with the ability to receive content incrementally.
   652 * the Browser Control with the ability to receive content incrementally.
   653 *
   653 *
   654 * @code
   654 * @code
   655 *  #include <brctlinterface.h>
   655 *  #include <BrCtlInterface.h>
   656 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   656 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   657 * @lib BrowserEngine.lib
   657 * @lib BrowserEngine.lib
   658 * @since 2.8
   658 * @since 2.8
   659 * @file brctlinterface.h
   659 * @file BrCtlInterface.h
   660 * @endcode     *
   660 * @endcode     *
   661 */
   661 */
   662 class MBrCtlDataLoadConsumer
   662 class MBrCtlDataLoadConsumer
   663     {
   663     {
   664     public: // New functions
   664     public: // New functions
   690 /**
   690 /**
   691 * The MBrCtlLoadEventObserver interface receives load progress events.
   691 * The MBrCtlLoadEventObserver interface receives load progress events.
   692 * The host application can implement this interface.
   692 * The host application can implement this interface.
   693 *
   693 *
   694 * @code
   694 * @code
   695 *  #include <brctlinterface.h>
   695 *  #include <BrCtlInterface.h>
   696 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   696 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0
   697 * @lib BrowserEngine.lib
   697 * @lib BrowserEngine.lib
   698 * @since 2.8
   698 * @since 2.8
   699 * @file brctlinterface.h
   699 * @file BrCtlInterface.h
   700 * @endcode     *
   700 * @endcode     *
   701 */
   701 */
   702 class MBrCtlLoadEventObserver
   702 class MBrCtlLoadEventObserver
   703     {
   703     {
   704     public: // New functions
   704     public: // New functions
   715 
   715 
   716 /**
   716 /**
   717 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   717 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.
   718 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   718 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.
   719 * @code
   719 * @code
   720 *  #include <brctlinterface.h>
   720 *  #include <BrCtlInterface.h>
   721 * @lib BrowserEngine.lib
   721 * @lib BrowserEngine.lib
   722 * @since 2.8
   722 * @since 2.8
   723 * @file brctlinterface.h
   723 * @file BrCtlInterface.h
   724 * @endcode     *
   724 * @endcode     *
   725 */
   725 */
   726 class TBrCtlWmlServiceOption
   726 class TBrCtlWmlServiceOption
   727     {
   727     {
   728     public:
   728     public:
   777     };
   777     };
   778 
   778 
   779 /**
   779 /**
   780 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   780 * The TBrCtlSubscribeTo class provides information of Subscribe to items.
   781 * @code
   781 * @code
   782 *  #include <brctlinterface.h>
   782 *  #include <BrCtlInterface.h>
   783 * @lib BrowserEngine.lib
   783 * @lib BrowserEngine.lib
   784 * @since 2.8
   784 * @since 2.8
   785 * @file brctlinterface.h
   785 * @file BrCtlInterface.h
   786 * @endcode     *
   786 * @endcode     *
   787 */
   787 */
   788 class TBrCtlSubscribeTo
   788 class TBrCtlSubscribeTo
   789     {
   789     {
   790     public:
   790     public:
   839 * the Image Map view. In Image Map view, only an image map is displayed,
   839 * the Image Map view. In Image Map view, only an image map is displayed,
   840 * which enables the user to navigate. The host application can
   840 * which enables the user to navigate. The host application can
   841 * implement this interface in order to find out when the view
   841 * implement this interface in order to find out when the view
   842 * changes to and from the Image Map view.
   842 * changes to and from the Image Map view.
   843 * @code
   843 * @code
   844 *  #include <brctlinterface.h>
   844 *  #include <BrCtlInterface.h>
   845 * @lib BrowserEngine.lib
   845 * @lib BrowserEngine.lib
   846 * @since 2.8
   846 * @since 2.8
   847 * @file brctlinterface.h
   847 * @file BrCtlInterface.h
   848 * @endcode     *
   848 * @endcode     *
   849 */
   849 */
   850 class MBrCtlStateChangeObserver
   850 class MBrCtlStateChangeObserver
   851     {
   851     {
   852     public:
   852     public: