epoc32/include/mw/caknmemoryselectionsettingpage.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
--- a/epoc32/include/mw/caknmemoryselectionsettingpage.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/mw/caknmemoryselectionsettingpage.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,137 @@
-caknmemoryselectionsettingpage.h
+/*
+* Copyright (c) 2002-2007 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
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Setting page used to selection target memory.
+*
+*/
+
+
+
+#ifndef C_AKNMEMORYSELECTIONSETTINGPAGE_H
+#define C_AKNMEMORYSELECTIONSETTINGPAGE_H
+
+
+#include <CAknMemorySelectionDialog.h>
+
+class MAknMemorySelectionObserver;
+
+/**
+ *  A class that launches a popup setting page for memory selection.
+ *
+ *  @lib CommonDialogs.lib
+ *  @since S60 1.2
+ */
+NONSHARABLE_CLASS(CAknMemorySelectionSettingPage)
+    : public CAknMemorySelectionDialog
+    {
+
+public:
+
+// Constructors and destructors
+
+    /**
+     * Static constructor. Loads default settings.
+     * @return Returns a pointer to an instance of itself.
+     */
+    IMPORT_C static CAknMemorySelectionSettingPage* NewL();
+
+    /**
+     * Static constructor.
+     * @param aResourceId A resource id (MEMORYSELECTIONDIALOG).
+     * @return Returns a pointer to an instance of itself.
+     */
+    IMPORT_C static CAknMemorySelectionSettingPage* NewL( TInt aResourceId );
+
+    IMPORT_C ~CAknMemorySelectionSettingPage();
+
+// New functions
+
+    /**
+     * Executes the memory selection setting page.
+     *
+     * @param aSelectedMemory A reference to a memory (TMemory).
+     *        If one of the memories is selected, the selected memory is
+     *        stored to the parameter.
+     * @return Returns true if user has selected an item and false
+     *         if user hits cancel.
+     */
+    IMPORT_C TReturnKey ExecuteL( TMemory& aSelectedMemory );
+
+
+    /**
+     * Executes the memory selection setting page.
+     *
+     * @param aSelectedMemory A reference to a memory (TMemory).
+     *        If one of the memories is selected, the selected memory is
+     *        stored to the parameter.
+     * @param aRootPath A pointer to a descriptor where the root path
+     *        of the selected memory is stored.
+     * @param aDefaultFolder A pointer to a descriptor where the default folder
+     *        of the selected memory is stored.
+     * @return Returns true if user has selected an item and false
+     *         if user hits cancel.
+     */
+    IMPORT_C TReturnKey ExecuteL(
+        TMemory& aSelectedMemory, TDes* aRootPath, TDes* aDefaultFolder );
+
+    /**
+     * Static methods for launching memory selection dialog
+     * Parameters & return value are descibed in method RunL
+     */
+
+    IMPORT_C static TBool RunDlgLD( TMemory& aSelectedMemory,
+        MAknMemorySelectionObserver* aObserver = NULL );
+
+    IMPORT_C static TBool RunDlgLD( TMemory& aSelectedMemory,
+        const TDesC& aTitle,
+        MAknMemorySelectionObserver* aObserver = NULL );
+
+    IMPORT_C static TBool RunDlgLD( TMemory& aSelectedMemory,
+        TInt aResourceId,
+        TDes* aRootPath = NULL, TDes* aDefaultFolder = NULL,
+        MAknMemorySelectionObserver* aObserver = NULL );
+
+private:    
+
+// Constructors and destructors
+
+    CAknMemorySelectionSettingPage();
+
+// New functions
+
+    /**
+     * A static method for launching a memory selection setting page.
+     * Creates, constructs, runs and deletes a memory selection dialog with
+     * different parameters.
+     *
+     * @param aResourceId An id of a resource.
+     * @param aSelectedMemory A reference to a memory described in ExecuteL.
+     * @param aTitle A title for memory selection dialog.
+     * @param aRootPath A pointer to a descriptor where the root path
+     *        of the selected memory is stored.
+     * @param aDefaultFolder A pointer to a descriptor where the default folder
+     *        of the selected memory is stored.
+     * @param aObserver An observer which is asked if the selected item
+     *        can be selected. Implemented in application.
+     */
+    static TBool RunL(
+        TInt aResourceId,
+        TMemory& aSelectedMemory,
+        const TDesC& aTitle,
+        TDes* aRootPath,
+        TDes* aDefaultFolder,
+        MAknMemorySelectionObserver* aObserver );
+
+    };
+
+#endif // C_AKNMEMORYSELECTIONSETTINGPAGE_H