author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 3 | e1b950c65cb4 |
permissions | -rw-r--r-- |
williamr@2 | 1 |
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
williamr@2 | 2 |
// All rights reserved. |
williamr@2 | 3 |
// This component and the accompanying materials are made available |
williamr@4 | 4 |
// under the terms of "Eclipse Public License v1.0" |
williamr@2 | 5 |
// which accompanies this distribution, and is available |
williamr@4 | 6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html". |
williamr@2 | 7 |
// |
williamr@2 | 8 |
// Initial Contributors: |
williamr@2 | 9 |
// Nokia Corporation - initial contribution. |
williamr@2 | 10 |
// |
williamr@2 | 11 |
// Contributors: |
williamr@2 | 12 |
// |
williamr@2 | 13 |
// Description: |
williamr@2 | 14 |
// |
williamr@2 | 15 |
|
williamr@2 | 16 |
#ifndef __EIKCMOBS_H__ |
williamr@2 | 17 |
#define __EIKCMOBS_H__ |
williamr@2 | 18 |
|
williamr@2 | 19 |
#include <e32def.h> |
williamr@2 | 20 |
|
williamr@2 | 21 |
class CCoeControl; |
williamr@2 | 22 |
|
williamr@2 | 23 |
/** Command observers respond to user commands, and have the secondary function |
williamr@2 | 24 |
of creating custom controls on request for classes such as CEikToolbar, or |
williamr@2 | 25 |
user-defined classes. |
williamr@2 | 26 |
|
williamr@2 | 27 |
An implementation of the pure virtual function ProcessCommandL() must be provided |
williamr@2 | 28 |
for each concrete class derived from MEikCommandObserver. CreateCustomCommandControlL() |
williamr@2 | 29 |
may also be re-implemented. |
williamr@2 | 30 |
|
williamr@2 | 31 |
@publishedAll |
williamr@2 | 32 |
@released */ |
williamr@2 | 33 |
class MEikCommandObserver |
williamr@2 | 34 |
{ |
williamr@2 | 35 |
public: |
williamr@2 | 36 |
/** Processes user commands. |
williamr@2 | 37 |
|
williamr@2 | 38 |
Derived classes must provide an implementation of this function which responds |
williamr@2 | 39 |
to user commands appropriately based on a user-defined ID for the command. |
williamr@2 | 40 |
|
williamr@2 | 41 |
@param aCommandId ID of the command to respond to. */ |
williamr@2 | 42 |
virtual void ProcessCommandL(TInt aCommandId)=0; |
williamr@2 | 43 |
/** Glue for creating custom controls. |
williamr@2 | 44 |
|
williamr@2 | 45 |
This function can be called to create custom controls on request from their |
williamr@2 | 46 |
control ID. Custom controls are user-supplied control classes. |
williamr@2 | 47 |
|
williamr@2 | 48 |
Given the ID of a custom control, this function should return a pointer to |
williamr@2 | 49 |
a newly-instantiated and fully constructed control. If the ID is unrecognised, |
williamr@2 | 50 |
NULL should be returned. The control returned will be owned by the caller. |
williamr@2 | 51 |
|
williamr@2 | 52 |
@param aControlType A custom control ID. |
williamr@2 | 53 |
@return By default, NULL. */ |
williamr@2 | 54 |
IMPORT_C virtual CCoeControl* CreateCustomCommandControlL(TInt aControlType); |
williamr@2 | 55 |
protected: |
williamr@2 | 56 |
IMPORT_C MEikCommandObserver(); |
williamr@2 | 57 |
private: |
williamr@2 | 58 |
IMPORT_C virtual void MEikCommandObserver_Reserved1(); |
williamr@2 | 59 |
IMPORT_C virtual void MEikCommandObserver_Reserved2(); |
williamr@2 | 60 |
private: |
williamr@2 | 61 |
TInt iMEikCommandObserver_Reserved1; |
williamr@2 | 62 |
}; |
williamr@2 | 63 |
|
williamr@2 | 64 |
#endif // __EIKCMOBS_H__ |