1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/eikcmobs.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,64 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __EIKCMOBS_H__
1.20 +#define __EIKCMOBS_H__
1.21 +
1.22 +#include <e32def.h>
1.23 +
1.24 +class CCoeControl;
1.25 +
1.26 +/** Command observers respond to user commands, and have the secondary function
1.27 +of creating custom controls on request for classes such as CEikToolbar, or
1.28 +user-defined classes.
1.29 +
1.30 +An implementation of the pure virtual function ProcessCommandL() must be provided
1.31 +for each concrete class derived from MEikCommandObserver. CreateCustomCommandControlL()
1.32 +may also be re-implemented.
1.33 +
1.34 +@publishedAll
1.35 +@released */
1.36 +class MEikCommandObserver
1.37 + {
1.38 +public:
1.39 + /** Processes user commands.
1.40 +
1.41 + Derived classes must provide an implementation of this function which responds
1.42 + to user commands appropriately based on a user-defined ID for the command.
1.43 +
1.44 + @param aCommandId ID of the command to respond to. */
1.45 + virtual void ProcessCommandL(TInt aCommandId)=0;
1.46 + /** Glue for creating custom controls.
1.47 +
1.48 + This function can be called to create custom controls on request from their
1.49 + control ID. Custom controls are user-supplied control classes.
1.50 +
1.51 + Given the ID of a custom control, this function should return a pointer to
1.52 + a newly-instantiated and fully constructed control. If the ID is unrecognised,
1.53 + NULL should be returned. The control returned will be owned by the caller.
1.54 +
1.55 + @param aControlType A custom control ID.
1.56 + @return By default, NULL. */
1.57 + IMPORT_C virtual CCoeControl* CreateCustomCommandControlL(TInt aControlType);
1.58 +protected:
1.59 + IMPORT_C MEikCommandObserver();
1.60 +private:
1.61 + IMPORT_C virtual void MEikCommandObserver_Reserved1();
1.62 + IMPORT_C virtual void MEikCommandObserver_Reserved2();
1.63 +private:
1.64 + TInt iMEikCommandObserver_Reserved1;
1.65 + };
1.66 +
1.67 +#endif // __EIKCMOBS_H__