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 #ifndef BRCTLINTERFACE_H

    20 #ifndef BRCTLINTERFACE_H

    19 #define BRCTLINTERFACE_H

    21 #define BRCTLINTERFACE_H

    20 

    22 

    21 //  INCLUDES

    23 //  INCLUDES

    22 #include <../bidi.h>

    24 #include <../bidi.h>

    24 #include <e32base.h>

    26 #include <e32base.h>

    25 #include <coecntrl.h>

    27 #include <coecntrl.h>

    26 #include <eikmenup.h>

    28 #include <eikmenup.h>

    27 #include <ssl.h>

    29 #include <ssl.h>

    28 

    30 

    37 

    39 

    38 // DATA TYPES

    40 // DATA TYPES

    39 

    41 

    40 // FORWARD DECLARATIONS

    42 // FORWARD DECLARATIONS

    41 class MBrCtlDataLoadSupplier;

    43 class MBrCtlDataLoadSupplier;

   105 * MBrCtlDialogsProvider etc.

   107 * MBrCtlDialogsProvider etc.

   106 *

   108 *

   107 * Usage:

   109 * Usage:

   108 *

   110 *

   109 * @code

   111 * @code

   111 *  // Interface that provides dialogs used by the Browser Control.

   113 *  // Interface that provides dialogs used by the Browser Control.

   113 *  // Interface used to receive scrolling events.

   115 *  // Interface used to receive scrolling events.

   115 *  //Interface that provides a callback mechanism for receiving the

   117 *  //Interface that provides a callback mechanism for receiving the

   116 *  //content of an embedded link or the content of a user-initiated

   118 *  //content of an embedded link or the content of a user-initiated

   117 *  //load request.

   119 *  //load request.

   119 *  //Interface that handles requests to change the softkeys.

   121 *  //Interface that handles requests to change the softkeys.

   121 *  //Interface that handles special load needs.

   123 *  //Interface that handles special load needs.

   123 *  //Reserved for future use.

   125 *  //Reserved for future use.

   125 *  //Interface that passes download events from the

   127 *  //Interface that passes download events from the

   126 *  //Download Manager through the Browser Control to the

   128 *  //Download Manager through the Browser Control to the

   127 *  //host application.

   129 *  //host application.

   129 *  Enum Definition of the Browser Control API.

   131 *  Enum Definition of the Browser Control API.

   131 *

   133 *

   132 *

   134 *

   133 *   The following types of things you can do with the Browser Control API.

   135 *   The following types of things you can do with the Browser Control API.

   134 *

   136 *

   135 * Creating a basic Browser Control

   137 * Creating a basic Browser Control

   145 * Receiving change-of-state events

   147 * Receiving change-of-state events

   146 *

   148 *

   147 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   149 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   148 * @lib BrowserEngine.lib

   150 * @lib BrowserEngine.lib

   149 * @since 2.8

   151 * @since 2.8

   151 * @endcode     *

   153 * @endcode     *

   152 */

   154 */

   153 class CBrCtlInterface : public CCoeControl

   155 class CBrCtlInterface : public CCoeControl

   154     {

   156     {

   155     public:  // Constructors and destructor

   157     public:  // Constructors and destructor

   615 * load operation, it can cancel that operation by means of this interface.

   617 * load operation, it can cancel that operation by means of this interface.

   616 *

   618 *

   617 * Usage:

   619 * Usage:

   618 *

   620 *

   619 * @code

   621 * @code

   621 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   623 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   622 * @lib BrowserEngine.lib

   624 * @lib BrowserEngine.lib

   623 * @since 2.8

   625 * @since 2.8

   625 * @endcode     *

   627 * @endcode     *

   626 */

   628 */

   627 class MBrCtlDataLoadSupplier

   629 class MBrCtlDataLoadSupplier

   628     {

   630     {

   629     public: // New functions

   631     public: // New functions

   640 /**

   642 /**

   641 * The MBrCtlDataLoadConsumer class is a callback interface that provides

   643 * The MBrCtlDataLoadConsumer class is a callback interface that provides

   642 * the Browser Control with the ability to receive content incrementally.

   644 * the Browser Control with the ability to receive content incrementally.

   643 *

   645 *

   644 * @code

   646 * @code

   646 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   648 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   647 * @lib BrowserEngine.lib

   649 * @lib BrowserEngine.lib

   648 * @since 2.8

   650 * @since 2.8

   650 * @endcode     *

   652 * @endcode     *

   651 */

   653 */

   652 class MBrCtlDataLoadConsumer

   654 class MBrCtlDataLoadConsumer

   653     {

   655     {

   654     public: // New functions

   656     public: // New functions

   680 /**

   682 /**

   681 * The MBrCtlLoadEventObserver interface receives load progress events.

   683 * The MBrCtlLoadEventObserver interface receives load progress events.

   682 * The host application can implement this interface.

   684 * The host application can implement this interface.

   683 *

   685 *

   684 * @code

   686 * @code

   686 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   688 * @see S60 Platform: Browser Control API Developer's Guide Version 2.0

   687 * @lib BrowserEngine.lib

   689 * @lib BrowserEngine.lib

   688 * @since 2.8

   690 * @since 2.8

   690 * @endcode     *

   692 * @endcode     *

   691 */

   693 */

   692 class MBrCtlLoadEventObserver

   694 class MBrCtlLoadEventObserver

   693     {

   695     {

   694     public: // New functions

   696     public: // New functions

   705 

   707 

   706 /**

   708 /**

   707 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.

   709 * The TBrCtlWmlServiceOption class wraps information about the WML DO elements.

   708 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.

   710 * For more information about the DO tag, see http://www.w3schools.com/wap/tag_do.asp.

   709 * @code

   711 * @code

   711 * @lib BrowserEngine.lib

   713 * @lib BrowserEngine.lib

   712 * @since 2.8

   714 * @since 2.8

   714 * @endcode     *

   716 * @endcode     *

   715 */

   717 */

   716 class TBrCtlWmlServiceOption

   718 class TBrCtlWmlServiceOption

   717     {

   719     {

   718     public:

   720     public:

   767     };

   769     };

   768 

   770 

   769 /**

   771 /**

   770 * The TBrCtlSubscribeTo class provides information of Subscribe to items.

   772 * The TBrCtlSubscribeTo class provides information of Subscribe to items.

   771 * @code

   773 * @code

   773 * @lib BrowserEngine.lib

   775 * @lib BrowserEngine.lib

   774 * @since 2.8

   776 * @since 2.8

   776 * @endcode     *

   778 * @endcode     *

   777 */

   779 */

   778 class TBrCtlSubscribeTo

   780 class TBrCtlSubscribeTo

   779     {

   781     {

   780     public:

   782     public:

   829 * the Image Map view. In Image Map view, only an image map is displayed,

   831 * the Image Map view. In Image Map view, only an image map is displayed,

   830 * which enables the user to navigate. The host application can

   832 * which enables the user to navigate. The host application can

   831 * implement this interface in order to find out when the view

   833 * implement this interface in order to find out when the view

   832 * changes to and from the Image Map view.

   834 * changes to and from the Image Map view.

   833 * @code

   835 * @code

   835 * @lib BrowserEngine.lib

   837 * @lib BrowserEngine.lib

   836 * @since 2.8

   838 * @since 2.8

   838 * @endcode     *

   840 * @endcode     *

   839 */

   841 */

   840 class MBrCtlStateChangeObserver

   842 class MBrCtlStateChangeObserver

   841     {

   843     {

   842     public:

   844     public: