1.1 --- a/epoc32/include/mw/aknsettingpage.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/mw/aknsettingpage.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,10 +1,10 @@
1.4 /*
1.5 -* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* Copyright (c) 2002-2009 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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* under the terms of "Eclipse Public License v1.0"
1.11 * which accompanies this distribution, and is available
1.12 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.13 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.14 *
1.15 * Initial Contributors:
1.16 * Nokia Corporation - initial contribution.
1.17 @@ -31,7 +31,7 @@
1.18 #include <eikmobs.h>
1.19
1.20 // for layout support
1.21 -#include <aknutils.h>
1.22 +#include <AknUtils.h>
1.23
1.24 // for navipane support (hint text)
1.25 #include <aknnavi.h>
1.26 @@ -262,7 +262,33 @@
1.27 * @param aCaption On return, this should be set to the caption of the target control.
1.28 */
1.29 void GetCaptionForFep(TDes& aCaption) const;
1.30 -
1.31 +
1.32 + /**
1.33 + * Calculates and returns setting item content rect.
1.34 + *
1.35 + * @param aScrollBarUsed @c ETrue if the setting page content should have
1.36 + * scrollbar, @c EFalse otherwise.
1.37 + *
1.38 + * @internal
1.39 + * @since 5.2
1.40 + * @return Setting item content rectangle.
1.41 + */
1.42 + TRect SettingItemContentRect( TBool aScrollBarUsed );
1.43 +
1.44 + /**
1.45 + * Is the setting page drawing the background itself or not (= "transparency")
1.46 + */
1.47 + TBool IsBackgroundDrawingEnabled() const;
1.48 +
1.49 +/**
1.50 +* Access method to the Command button array
1.51 +*
1.52 +* Must be called after full construction, or null reference will be returned.
1.53 +*
1.54 +* @return CEikButtonGroupContainer* a pointer to the cba owned by the setting page
1.55 +*/
1.56 + IMPORT_C CEikButtonGroupContainer* Cba() const ;
1.57 +
1.58 protected:
1.59
1.60 /**
1.61 @@ -419,15 +445,6 @@
1.62 IMPORT_C TBool Waiting();
1.63
1.64 /**
1.65 -* Access method to the Command button array
1.66 -*
1.67 -* Must be called after full construction, or null reference will be returned.
1.68 -*
1.69 -* @return CEikButtonGroupContainer* a pointer to the cba owned by the setting page
1.70 -*/
1.71 - IMPORT_C CEikButtonGroupContainer* Cba() const ;
1.72 -
1.73 -/**
1.74 * This is used to access the default resource id for the cba - the one used when
1.75 * data is valid.
1.76 *
1.77 @@ -512,39 +529,41 @@
1.78 */
1.79 IMPORT_C virtual void CheckAndSetDataValidity();
1.80
1.81 -/**
1.82 - * Method to be called by CAknSettingPage descendents when they have laid themselves out.
1.83 - * This tells the base class how big the layout spec rectangle hosting the editor is.
1.84 - * The second rectangle is the size of the area that the base class does not have to
1.85 - * draw to for skins. Usually, this is the area actually inhabited by the editor control.
1.86 - *
1.87 - * Coordinates are to be given in pixels relative to the main_pane.
1.88 - *
1.89 - * @param aFrameRect Layout rectangle in which to host the editor.
1.90 - * @param aRealEditorRect Layout rectangle actually occupied by the editor control
1.91 - *
1.92 - * @since 2.0
1.93 - */
1.94 - void SetEditedItemLayoutRect( const TRect& aFrameRect, const TRect& aRealEditorRect);
1.95 -
1.96 - /**
1.97 - * Method to cause this class to construct a control context or type and IID, selected according to
1.98 - * the value of enumeration TEditedItemSkinClass, set its coordinate system
1.99 - *
1.100 - * This must be called after a call to SetEditedItemLayoutRect has been made on CAknSettingPage.
1.101 - * This is becasue this routine must set the control context's origin to the top left of the value
1.102 - * given to SetEditedItemLayoutRect. Since SetEditeItemLayoutRect is to be called in a SizeChanged
1.103 - * method, this means that the this should be called after the SizeChanged in the child class.
1.104 -
1.105 - * @param aClass enumeration specifying which class of editor (according to LAF spec) is being
1.106 - * constructed.
1.107 - * @param aParentAbsolute ETrue if there is an intervening Window between CAknSettingPage's window
1.108 - * and any control that is to draw skin items with this component.
1.109 - *
1.110 - * since 2.0
1.111 - *
1.112 - */
1.113 - void CreateEditedItemControlContextL( TEditedItemSkinClass aSkinClass, TBool aParentAbsolute);
1.114 + /**
1.115 + * Sets the outer and inner rectangle for the frame graphics that is drawn
1.116 + * around the setting item.
1.117 + *
1.118 + * @param aOuterRect Frame outer rectangle.
1.119 + * @param aInnerRect Frame inner rectangle.
1.120 + *
1.121 + * @since 5.2
1.122 + */
1.123 + void SetEditedItemFrameRects( const TRect& aOuterRect,
1.124 + const TRect& aInnerRect );
1.125 +
1.126 + /**
1.127 + * Sets the skin item ID for the frame graphics that is drawn
1.128 + * around the setting item.
1.129 + *
1.130 + * @param aFrameIID Skin item ID of the frame graphics.
1.131 + * @param aFrameCenterIID Skin item ID of the center piece of the frame
1.132 + * graphics
1.133 + *
1.134 + * @since 5.2
1.135 + */
1.136 + void SetEditedItemFrameIID( const TAknsItemID& aFrameIID,
1.137 + const TAknsItemID& aFrameCenterIID );
1.138 +
1.139 + /**
1.140 + * Sets the rectangle for the editing state indicators.
1.141 + * Should only be called by setting pages that have an editor which
1.142 + * displays the editor indicators as the editor control.
1.143 + *
1.144 + * @param aRect Editor indicator rectangle.
1.145 + *
1.146 + * @since 5.2
1.147 + */
1.148 + void SetEditorIndicatorRect( const TRect& aRect );
1.149
1.150 /**
1.151 * Indicates whether skin system will be able to draw the editor frame and background
1.152 @@ -563,6 +582,19 @@
1.153 */
1.154 CAknsFrameBackgroundControlContext* EditedItemControlContext() const;
1.155
1.156 + /**
1.157 + * Performs base construction and takes possible flags into account.
1.158 + *
1.159 + * @param aFlags Construction flags
1.160 + *
1.161 + * @since 5.2
1.162 + */
1.163 + void BaseConstructL( TUint aFlags );
1.164 +
1.165 + /**
1.166 + * Stop current (additional) level on the active scheduler.
1.167 + */
1.168 + void StopActiveScheduler();
1.169
1.170 protected:
1.171 /**
1.172 @@ -676,10 +708,6 @@
1.173 * Activate another level on the active scheduler
1.174 */
1.175 void StartActiveScheduler();
1.176 - /**
1.177 - * Stop current (additional) level on the active scheduler
1.178 - */
1.179 - void StopActiveScheduler();
1.180
1.181 /**
1.182 * Pop the navidecorator. The iNaviPane is used as a flag to show if popping is required to
1.183 @@ -705,10 +733,6 @@
1.184 void SetDrawBackground(const TBool aDrawBackground);
1.185
1.186 /**
1.187 - * Is the setting page drawing the background itself or not (= "transparency")
1.188 - */
1.189 - TBool IsBackgroundDrawingEnabled() const;
1.190 - /**
1.191 * Set the flag to indicate that if the function CAknSettingPage::StopActiveScheduler called or not
1.192 *@param aStopCalled ETrue means the StopActiveScheduler is called.
1.193 */