epoc32/include/mw/brctlwindowobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/brctlwindowobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/brctlwindowobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,98 @@
     1.4 -brctlwindowobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Eclipse Public License v1.0"
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Handle multiple windows events such as open/close/etc
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef BRCTLWINDOWOBSERVER_H
    1.24 +#define BRCTLWINDOWOBSERVER_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <e32std.h>
    1.28 +#include <e32base.h>
    1.29 +#include <BrCtlDefs.h>
    1.30 +
    1.31 +// CONSTANTS
    1.32 +
    1.33 +// MACROS
    1.34 +
    1.35 +// DATA TYPES
    1.36 +enum TBrCtlWindowCommand
    1.37 +    {
    1.38 +    EFocusWindow,
    1.39 +    EUnfocusWindow,
    1.40 +    EShowWindow,
    1.41 +    ECloseWindow
    1.42 +    };
    1.43 +
    1.44 +// FUNCTION PROTOTYPES
    1.45 +
    1.46 +// FORWARD DECLARATIONS
    1.47 +class CBrCtlInterface;
    1.48 +
    1.49 +/**
    1.50 +* The MBrCtlWindowObserver class handles window events such open/close/etc
    1.51 +*
    1.52 +* Usage:
    1.53 +*
    1.54 +* @code
    1.55 +*  #include <BrCtlWindowObserver.h>
    1.56 +*
    1.57 +* @see S60 Platform: Browser Control API Developer's Guide Version 2.0
    1.58 +* @lib BrowserEngine.lib
    1.59 +* @since 3.0
    1.60 +* @file BrCtlWindowObserver.h
    1.61 +* @endcode     *
    1.62 +*/
    1.63 +class MBrCtlWindowObserver
    1.64 +    {
    1.65 +    public: // New functions
    1.66 +        /**
    1.67 +        * Request the host applicaion to open the URL in a new window
    1.68 +        * @since 3.0
    1.69 +        * @param aUrl The Url of the request to be done in the new window
    1.70 +        * @param aTargetName The name of the new window
    1.71 +        * @param aUserInitiated ETrue if the new window is initiated by a user event (click)
    1.72 +        * @param aMethod The method to be used for fetching the supplied url
    1.73 +        * @param aContentType If the method is POST, this is the content type of the data to be posted 
    1.74 +        * @param aPostData If the method is POST, this is the data to be posted 
    1.75 +        * @param aBoundary The boundary used if the content is multipart/form-data
    1.76 +        * @param aReserved For future use
    1.77 +        * @return Return Value is the new browser control associated with the new window
    1.78 +        */
    1.79 +        virtual CBrCtlInterface* OpenWindowL(TDesC& aUrl, TDesC* aTargetName, TBool aUserInitiated, 
    1.80 +             TAny* aReserved) = 0;
    1.81 +
    1.82 +        /**
    1.83 +        * Find a window by target name
    1.84 +        * @since 3.0
    1.85 +        * @param aTargetName name of the window to find
    1.86 +        * @return Return Value is the browser control associated with the window name
    1.87 +        */
    1.88 +        virtual CBrCtlInterface* FindWindowL( const TDesC& aTargetName ) const = 0;             
    1.89 +
    1.90 +        /**
    1.91 +        * Handle window events such as close/focus etc
    1.92 +        * @since 3.0
    1.93 +        * @param aTargetName name of the window to send the event to
    1.94 +        * @param aCommand Command to pass to the window
    1.95 +        * @return void
    1.96 +        */
    1.97 +        virtual void HandleWindowCommandL( const TDesC& aTargetName, TBrCtlWindowCommand aCommand ) = 0;
    1.98 +    };
    1.99 +
   1.100 +#endif      // BRCTLWINDOWOBSERVER_H
   1.101 +            
   1.102 +// End of File