API_REF/Public_API: comparison epoc32/include/mw/aknsettingpage.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 /*
-* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
-* 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
+* under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
-* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 #include <eikmenub.h>
 #include <eikmenup.h>
 #include <eikmobs.h>
 // for layout support
-#include <aknutils.h>
+#include <AknUtils.h>
 // for navipane support (hint text)
 #include <aknnavi.h>
 //
 *
 * @since 5.0
 * @param  aCaption On return, this should be set to the caption of the target control.
 */
 void GetCaptionForFep(TDes& aCaption) const;
+/**
+* Calculates and returns setting item content rect.
+*
+* @param  aScrollBarUsed  @c ETrue if the setting page content should have
+*                         scrollbar, @c EFalse otherwise.
+*
+* @internal
+* @since 5.2
+* @return Setting item content rectangle.
+*/
+TRect SettingItemContentRect( TBool aScrollBarUsed );
+/**
+* Is the setting page drawing the background itself or not (= "transparency")
+*/
+TBool IsBackgroundDrawingEnabled() const;
+/**
+* Access method to the Command button array
+*
+* Must be called after full construction, or null reference will be returned.
+*
+* @return CEikButtonGroupContainer* a pointer to the cba owned by the setting page
+*/
+IMPORT_C CEikButtonGroupContainer* Cba() const ;
 protected:
 /**
 * From CCoeControl
 * This routine is called as part of the set-up of the control.	It is the place to put
 * @return	EFalse only if the CActiveSheduler level is not running
 */
 	IMPORT_C TBool Waiting();
 /**
-* Access method to the Command button array
-*
-* Must be called after full construction, or null reference will be returned.
-*
-* @return CEikButtonGroupContainer* a pointer to the cba owned by the setting page
-*/
-	IMPORT_C CEikButtonGroupContainer* Cba() const ;
-/**
 * This is used to access the default resource id for the cba - the one used when
 * data is valid.
 *
 * @return TInt 	the default resource Id
 */
 * This is called when the data changes.
 *
 */
 	IMPORT_C virtual void CheckAndSetDataValidity();
-/**
+	/**
-* Method to be called by CAknSettingPage descendents when they have laid themselves out.
+* Sets the outer and inner rectangle for the frame graphics that is drawn
-* This tells the base class how big the layout spec rectangle hosting the editor is.
+	 * around the setting item.
-* The second rectangle is the size of the area that the base class does not have to
+*
-* draw to for skins. Usually, this is the area actually inhabited by the editor control.
+* @param  aOuterRect  Frame outer rectangle.
-*
+* @param  aInnerRect  Frame inner rectangle.
-* Coordinates are to be given in pixels relative to the main_pane.
+*
-*
+* @since 5.2
-* @param aFrameRect		Layout rectangle in which to host the editor.
+*/
-* @param aRealEditorRect	Layout rectangle actually occupied by the editor control
+	void SetEditedItemFrameRects( const TRect& aOuterRect,
-*
+const TRect& aInnerRect );
-* @since 2.0
-*/
+	/**
-	void SetEditedItemLayoutRect( const TRect& aFrameRect, const TRect& aRealEditorRect);
+* Sets the skin item ID for the frame graphics that is drawn
+* around the setting item.
-/**
+*
-* Method to cause this class to construct a control context or type and IID, selected according to
+* @param  aFrameIID        Skin item ID of the frame graphics.
-* the value of enumeration TEditedItemSkinClass, set its coordinate system
+* @param  aFrameCenterIID  Skin item ID of the center piece of the frame
-*
+*                          graphics
-* This must be called after a call to SetEditedItemLayoutRect has been made on CAknSettingPage.
+*
-* This is becasue this routine must set the control context's origin to the top left of the value
+* @since 5.2
-* given to SetEditedItemLayoutRect. Since SetEditeItemLayoutRect is to be called in a SizeChanged
+*/
-* method, this means that the this should be called after the SizeChanged in the child class.
+void SetEditedItemFrameIID( const TAknsItemID& aFrameIID,
+const TAknsItemID& aFrameCenterIID );
-* @param	aClass	enumeration specifying which class of editor (according to LAF spec) is being
-* constructed.
+/**
-* @param	aParentAbsolute	ETrue if there is an intervening Window between CAknSettingPage's window
+* Sets the rectangle for the editing state indicators.
-* and any control that is to draw skin items with this component.
+* Should only be called by setting pages that have an editor which
-*
+* displays the editor indicators as the editor control.
-* since 2.0
+*
-*
+* @param  aRect  Editor indicator rectangle.
-*/
+*
-	void CreateEditedItemControlContextL( TEditedItemSkinClass aSkinClass, TBool aParentAbsolute);
+* @since 5.2
+*/
+void SetEditorIndicatorRect( const TRect& aRect );
 /**
 * Indicates whether skin system will be able to draw the editor frame and background
 *
 * @return TBool ETrue iff the drawing of the edited item frame is going to be handled by
 * @return      A valid control context for frame drawing for a hosted editor or NULL
 * @since 2.0
 */
 CAknsFrameBackgroundControlContext* EditedItemControlContext() const;
+	/**
+* Performs base construction and takes possible flags into account.
+*
+* @param  aFlags Construction flags
+*
+* @since 5.2
+*/
+void BaseConstructL( TUint aFlags );
+/**
+* Stop current (additional) level on the active scheduler.
+*/
+	void StopActiveScheduler();
 protected:
 /**
 * From MEikMenuObserver
 * Called when menu is cancelled.
 /**
 * Activate another level on the active scheduler
 */
 	void StartActiveScheduler();
-/**
-* Stop current (additional) level on the active scheduler
-*/
-	void StopActiveScheduler();
 /**
 * Pop the navidecorator. The iNaviPane is used as a flag to show if popping is required to
 * be done or not. It is zeroed by this method.
 *
 * Enables / disables transparency effect, i.e. does the setting page draw its own background or not.
 * @param aDrawBackground  EFalse enables transparency
 */
 void SetDrawBackground(const TBool aDrawBackground);
-/**
-* Is the setting page drawing the background itself or not (= "transparency")
-*/
-TBool IsBackgroundDrawingEnabled() const;
 /**
 * Set the flag to indicate that if the function CAknSettingPage::StopActiveScheduler called or not
 *@param aStopCalled ETrue means the StopActiveScheduler is called.
 */
 void SetStopActiveSchedulerFlag(const TBool aStopCalled );

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811