epoc32/include/mw/aknstaticnotedialog.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef __AKNSTATICNOTEDIALOG__
williamr@2
    20
#define __AKNSTATICNOTEDIALOG__
williamr@2
    21
williamr@2
    22
#include <aknnotedialog.h>
williamr@2
    23
#include <AknControl.h>
williamr@2
    24
williamr@2
    25
class CEikImage;
williamr@2
    26
class CAknStackIndicatorAttributes;
williamr@2
    27
williamr@2
    28
/**
williamr@2
    29
 * Static note stack indicator
williamr@2
    30
 */
williamr@2
    31
class CAknStaticNoteStackIndicator : public CAknControl
williamr@2
    32
	{
williamr@2
    33
public:
williamr@2
    34
    /**
williamr@2
    35
     * 2nd stage construction.
williamr@2
    36
     *
williamr@2
    37
    */
williamr@2
    38
	void ConstructL(CCoeControl* aParentNote, TInt aStackDepth);
williamr@2
    39
	
williamr@2
    40
	/**
williamr@2
    41
     * Updates stack depth
williamr@2
    42
     *
williamr@2
    43
    */
williamr@2
    44
	void UpdateDepth(TInt aDepth);
williamr@2
    45
	
williamr@2
    46
	~CAknStaticNoteStackIndicator();
williamr@2
    47
	
williamr@2
    48
    /**
williamr@2
    49
     * From @c CCoeControl.
williamr@2
    50
     * 
williamr@2
    51
     * Handles a change to the control's resources. The types of resources 
williamr@2
    52
     * handled are those which are shared across the environment, e.g. 
williamr@2
    53
     * colours or fonts.
williamr@2
    54
     *
williamr@2
    55
     */
williamr@2
    56
	IMPORT_C void HandleResourceChange(TInt aType);
williamr@2
    57
    
williamr@2
    58
    /**
williamr@2
    59
     * From @c CCoeControl. 
williamr@2
    60
     * Handles pointer events
williamr@2
    61
    */
williamr@2
    62
    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
williamr@2
    63
    	
williamr@2
    64
private:
williamr@2
    65
	void Draw(const TRect& aRect) const;
williamr@2
    66
	void DoSetExtent();
williamr@2
    67
	
williamr@2
    68
private:
williamr@2
    69
    /**
williamr@2
    70
    * From CAknControl
williamr@2
    71
    */
williamr@2
    72
    IMPORT_C void* ExtensionInterface( TUid aInterface );
williamr@2
    73
williamr@2
    74
private:
williamr@2
    75
	CAknStackIndicatorAttributes* iAttributes;
williamr@2
    76
	CCoeControl* iParentNote;
williamr@2
    77
	};
williamr@2
    78
williamr@2
    79
williamr@2
    80
/**
williamr@2
    81
 * Static note dialog
williamr@2
    82
 */
williamr@2
    83
class CAknStaticNoteDialog : public CAknNoteDialog
williamr@2
    84
	{
williamr@2
    85
	
williamr@2
    86
public:
williamr@2
    87
    /**
williamr@2
    88
     * Default constructor    
williamr@2
    89
     * Just call CAknNoteDialog constructor
williamr@2
    90
    */
williamr@2
    91
	IMPORT_C CAknStaticNoteDialog();
williamr@2
    92
	
williamr@2
    93
	/**
williamr@2
    94
     * Another class constructor
williamr@2
    95
     *
williamr@2
    96
     * Accept self pointer to CEikDialog* in order to NULL 
williamr@2
    97
     * client pointer when a non modal note is dismissed.
williamr@2
    98
     *
williamr@2
    99
     * @param aSelfPtr Address of the dialog pointer
williamr@2
   100
    */
williamr@2
   101
	IMPORT_C CAknStaticNoteDialog(CEikDialog** aSelfPtr);
williamr@2
   102
	
williamr@2
   103
	IMPORT_C virtual ~CAknStaticNoteDialog();
williamr@2
   104
williamr@2
   105
    /**
williamr@2
   106
     * Set the number of borders
williamr@2
   107
     *
williamr@2
   108
     * Update the stack indicator depth to the specified number of borders. 
williamr@2
   109
     * 
williamr@2
   110
     * @param aNumber    The number of borders
williamr@2
   111
    */
williamr@2
   112
    IMPORT_C void SetNumberOfBorders(TInt aNumber);
williamr@2
   113
williamr@2
   114
    /**
williamr@2
   115
     * Handles pointer events
williamr@2
   116
    */
williamr@2
   117
    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);	
williamr@2
   118
williamr@2
   119
protected:
williamr@2
   120
    /**
williamr@2
   121
     * Part of dialog framework, called after layout has been performed
williamr@2
   122
     *
williamr@2
   123
     * Call PostLayoutDynInitL as implemented in the base, CAknNoteDialog
williamr@2
   124
     * and create a stack indicator
williamr@2
   125
     * 
williamr@2
   126
    */
williamr@2
   127
	IMPORT_C void PostLayoutDynInitL();
williamr@2
   128
	
williamr@2
   129
	/**
williamr@2
   130
     * Part of the dialog framework, process a key event.
williamr@2
   131
     *
williamr@2
   132
     * Call the implementation of OfferKeyEventL provided by
williamr@2
   133
     * CEikDialog, bypassing the direct base, CAknNoteDialog.
williamr@2
   134
    */
williamr@2
   135
	IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);
williamr@2
   136
williamr@2
   137
protected:
williamr@2
   138
    /**
williamr@2
   139
     * Stack indicator    
williamr@2
   140
     * 
williamr@2
   141
    */
williamr@2
   142
	CAknStaticNoteStackIndicator* iStackIndicator;
williamr@2
   143
	
williamr@2
   144
	/**
williamr@2
   145
     * Indicates stack depth    
williamr@2
   146
     *
williamr@2
   147
    */
williamr@2
   148
	TInt iStackDepth;
williamr@2
   149
	
williamr@2
   150
private:
williamr@2
   151
	TInt iSpare;
williamr@2
   152
	
williamr@2
   153
private:
williamr@2
   154
    /**
williamr@2
   155
    * From CAknControl
williamr@2
   156
    */
williamr@2
   157
    IMPORT_C void* ExtensionInterface( TUid aInterface );
williamr@2
   158
    
williamr@2
   159
private: 
williamr@2
   160
	IMPORT_C virtual void CEikDialog_Reserved_1();
williamr@2
   161
	IMPORT_C virtual void CEikDialog_Reserved_2();
williamr@2
   162
		
williamr@2
   163
private: 
williamr@2
   164
	IMPORT_C virtual void CAknNoteDialog_Reserved();
williamr@2
   165
	
williamr@2
   166
private: // new virtual function.
williamr@2
   167
	IMPORT_C virtual void CAknStaticNoteDialog_Reserved();
williamr@2
   168
	};
williamr@2
   169
williamr@2
   170
#endif