1.1 --- a/epoc32/include/mw/akncommondialogsdynmem.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/akncommondialogsdynmem.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,757 @@
1.4 -akncommondialogsdynmem.h
1.5 +/*
1.6 +* Copyright (c) 2002-2007 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 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Static class to call combined common file dialogs
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +
1.24 +#ifndef AKNCOMMONDIALOGSDYNMEM_H
1.25 +#define AKNCOMMONDIALOGSDYNMEM_H
1.26 +
1.27 +
1.28 +#include <CAknCommonDialogsBase.h>
1.29 +
1.30 +class MAknMemorySelectionObserver;
1.31 +class MAknFileSelectionObserver;
1.32 +class MAknFileFilter;
1.33 +
1.34 +
1.35 +/**
1.36 + * New version of AknCommonDialogs class suporting dynamic drives such as
1.37 + * remote drive. Use this instead of now deprecated old AknCommonDialogs.
1.38 + *
1.39 + * A simple facade class that consists of static functions that launch UI
1.40 + * components in a sequence. First, memory selection component is launched and
1.41 + * then file/directory selection component. In save and move dialogs directory
1.42 + * selection may not be shown if there are no subdirectories to choose from.
1.43 + * In save dialog, finally filename prompt component is launched.
1.44 + *
1.45 + * All methods have an obligatory resource ID parameter for memory selection
1.46 + * because it contains the paths for both memories (Phone&MMC) (LOCATION
1.47 + * structs). New TMemoryTypes functionality allows defining dynamic memories
1.48 + * to be used.
1.49 + *
1.50 + * If set, an observer is queried just before exiting the dialog.
1.51 + * At this point the application can either reject or accept user's selection.
1.52 + * Every dialog returns a boolean value which tells if user has selected
1.53 + * something or not.
1.54 + *
1.55 + * @lib CommonDialogs.lib
1.56 + * @since S60 3.2
1.57 + */
1.58 +NONSHARABLE_CLASS( AknCommonDialogsDynMem )
1.59 + {
1.60 +
1.61 +public:
1.62 +
1.63 + /**
1.64 + * Bit flag definition of the memory types that will be listed by the
1.65 + * dialog. These are used in the new functions to include for example
1.66 + * remote drives. In case new media types are added in the future, the
1.67 + * types can be added to the end of this enumeration.
1.68 + *
1.69 + * Application logic and UI specification is mainly interested in
1.70 + * division between 'phone memory' and 'MMC' with the latest addition of
1.71 + * 'remote drives'. In Symbian OS level this is somewhat more
1.72 + * complicated because these do not map directly to any drive or memory
1.73 + * type. For example try defining the drive letter for remote drive.
1.74 + *
1.75 + * Basically TMediaType could be used but the types may vary in the same
1.76 + * drive and application logic mostly understands only division between
1.77 + * 'phone' and 'MMC' memory - these do not map to TMediaType directly.
1.78 + * This the reasoning for this new enumeration.
1.79 + *
1.80 + * Uses binary flagging.
1.81 + *
1.82 + * Use for example 'EMemoryTypePhone|EMemoryTypeMMC|EMemoryTypeRemote' to
1.83 + * have phone memory, MMC and remote drives included.
1.84 + *
1.85 + * Notice: 0 value means no media included. Only
1.86 + * EMemoryTypePhone|EMemoryTypeMMC for legacy applications and
1.87 + * EMemoryTypePhone|EMemoryTypeMMC|EMemoryTypeRemote for new remote
1.88 + * drives-aware applications are supported for the time being.
1.89 + * Use EMemoryTypePhone|EMemoryTypeInternalMassStorage|EMemoryMMCExternal
1.90 + * |EMemoryTypeRemote for multiple drive support. And EMemoryTypeMMC will
1.91 + * be deprecated.
1.92 + */
1.93 + enum TMemoryTypes
1.94 + {
1.95 + /**
1.96 + * EMemoryTypePhone
1.97 + * Device memory drive inside phone
1.98 + *
1.99 + * There might be multiple device memory drives because of multiple
1.100 + * partitions.
1.101 + */
1.102 + EMemoryTypePhone = 0x00000001,
1.103 +
1.104 + /**
1.105 + * @Deprecated It will be mapped to
1.106 + * EMemoryTypeInternalMassStorage|EMemoryMMCExternal
1.107 + * internally.
1.108 + *
1.109 + * EMemoryTypeMMC
1.110 + * Standard external removable memory card drive
1.111 + *
1.112 + * There might be multiple removable MMC drives because of
1.113 + * multiple partitions.
1.114 + */
1.115 + EMemoryTypeMMC = 0x00000002,
1.116 +
1.117 + /**
1.118 + * EMemoryTypeRemote
1.119 + * Remote drive
1.120 + *
1.121 + * There might be multiple remote drives.
1.122 + */
1.123 + EMemoryTypeRemote = 0x00000004,
1.124 +
1.125 + /**
1.126 + * EMemoryTypeInternalMassStorage
1.127 + * Internal mass storage, like internal MMC, hard disk, flash, etc.
1.128 + *
1.129 + * There might be multiple internal disk drives
1.130 + */
1.131 + EMemoryTypeInternalMassStorage = 0x00000008,
1.132 +
1.133 + /**
1.134 + * EMemoryTypeMMCExternal
1.135 + * Removable external memory card
1.136 + *
1.137 + */
1.138 + EMemoryTypeMMCExternal = 0x00000010
1.139 +
1.140 + };
1.141 +
1.142 +public:
1.143 +
1.144 + /**
1.145 + * A static method that launches file selection dialog.
1.146 + * @param aIncludedMedias defines which medias are included in the
1.147 + * dialog. See TMemoryTypes.
1.148 + * @param aFileName Full path and filename of the file that user
1.149 + * selects is stored to this descriptor.
1.150 + * @param aMemorySelectionResourceId A resource id for memory selection
1.151 + * dialog.
1.152 + * @param aObserver An observer which is asked, if set, to verify user's
1.153 + * selection.
1.154 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.155 + */
1.156 + IMPORT_C static TBool RunSelectDlgLD(
1.157 + TInt aIncludedMedias,
1.158 + TDes& aFileName,
1.159 + TInt aMemorySelectionResourceId,
1.160 + MAknFileSelectionObserver* aObserver = NULL );
1.161 +
1.162 + /**
1.163 + * A static method that launches file selection dialog.
1.164 + * @param aIncludedMedias defines which medias are included in the
1.165 + * dialog. See TMemoryTypes.
1.166 + * @param aFileName Full path and filename of the file that user
1.167 + * selects is stored to this descriptor.
1.168 + * @param aMemorySelectionResourceId A resource id for memory selection
1.169 + * dialog.
1.170 + * @param aFilter Filter is asked if a directory entry can be shown in
1.171 + * list. Ownership is not transferred.
1.172 + * @param aObserver An observer which is asked, if set, to verify user's
1.173 + * selection.
1.174 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.175 + */
1.176 + IMPORT_C static TBool RunSelectDlgLD(
1.177 + TInt aIncludedMedias,
1.178 + TDes& aFileName,
1.179 + TInt aMemorySelectionResourceId,
1.180 + MAknFileFilter* aFilter,
1.181 + MAknFileSelectionObserver* aObserver = NULL );
1.182 +
1.183 + /**
1.184 + * A static method that launches file selection dialog.
1.185 + * @param aIncludedMedias defines which medias are included in the
1.186 + * dialog. See TMemoryTypes.
1.187 + * @param aFileName Full path and filename of the file that user
1.188 + * selects is stored to this descriptor.
1.189 + * @param aMemorySelectionResourceId A resource id for memory selection
1.190 + * dialog.
1.191 + * @param aFileSelectionTitle A custom title for file selection dialog.
1.192 + * @param aObserver An observer which is asked, if set, to verify user's
1.193 + * selection.
1.194 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.195 + */
1.196 + IMPORT_C static TBool RunSelectDlgLD(
1.197 + TInt aIncludedMedias,
1.198 + TDes& aFileName,
1.199 + TInt aMemorySelectionResourceId,
1.200 + const TDesC& aFileSelectionTitle,
1.201 + MAknFileSelectionObserver* aObserver = NULL );
1.202 +
1.203 + /**
1.204 + * A static method that launches file selection dialog.
1.205 + * @param aIncludedMedias defines which medias are included in the
1.206 + * dialog. See TMemoryTypes.
1.207 + * @param aFileName Full path and filename of the file that user
1.208 + * selects is stored to this descriptor.
1.209 + * @param aMemorySelectionResourceId A resource id for memory selection
1.210 + * dialog.
1.211 + * @param aFileSelectionResourceId A resource id for file selection
1.212 + * dialog.
1.213 + * @param aObserver An observer which is asked, if set, to verify user's
1.214 + * selection.
1.215 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.216 + */
1.217 + IMPORT_C static TBool RunSelectDlgLD(
1.218 + TInt aIncludedMedias,
1.219 + TDes& aFileName,
1.220 + TInt aMemorySelectionResourceId,
1.221 + TInt aFileSelectionResourceId,
1.222 + MAknFileSelectionObserver* aObserver = NULL );
1.223 +
1.224 + /**
1.225 + * A static method that launches move dialog.
1.226 + * @param aIncludedMedias defines which medias are included in the
1.227 + * dialog. See TMemoryTypes.
1.228 + * @param aDirectory Full path of the folder that user
1.229 + * selects is stored to this descriptor.
1.230 + * @param aMemorySelectionResourceId A resource id for memory selection
1.231 + * dialog.
1.232 + * @param aObserver An observer which is asked, if set, to verify user's
1.233 + * selection.
1.234 + * @return Returns ETrue if user selects a folder, otherwise EFalse.
1.235 + */
1.236 + IMPORT_C static TBool RunMoveDlgLD(
1.237 + TInt aIncludedMedias,
1.238 + TDes& aDirectory,
1.239 + TInt aMemorySelectionResourceId,
1.240 + MAknFileSelectionObserver* aObserver = NULL );
1.241 +
1.242 + /**
1.243 + * A static method that launches move dialog.
1.244 + * @param aIncludedMedias defines which medias are included in the
1.245 + * dialog. See TMemoryTypes.
1.246 + * @param aDirectory Full path of the folder that user
1.247 + * selects is stored to this descriptor.
1.248 + * @param aMemorySelectionResourceId A resource id for memory selection
1.249 + * dialog.
1.250 + * @param aFilter Filter is asked if a directory entry can be shown in
1.251 + * list. Ownership is not transferred.
1.252 + * @param aObserver An observer which is asked, if set, to verify user's
1.253 + * selection.
1.254 + * @return Returns ETrue if user selects a folder, otherwise EFalse.
1.255 + */
1.256 + IMPORT_C static TBool RunMoveDlgLD(
1.257 + TInt aIncludedMedias,
1.258 + TDes& aDirectory,
1.259 + TInt aMemorySelectionResourceId,
1.260 + MAknFileFilter* aFilter,
1.261 + MAknFileSelectionObserver* aObserver = NULL );
1.262 +
1.263 + /**
1.264 + * A static method that launches move dialog.
1.265 + * @param aIncludedMedias defines which medias are included in the
1.266 + * dialog. See TMemoryTypes.
1.267 + * @param aDirectory Full path of the folder that user
1.268 + * selects is stored to this descriptor.
1.269 + * @param aMemorySelectionResourceId A resource id for memory selection
1.270 + * dialog.
1.271 + * @param aFileSelectionTitle A custom title for directory selection
1.272 + * dialog.
1.273 + * @param aObserver An observer which is asked, if set, to verify user's
1.274 + * selection.
1.275 + * @return Returns ETrue if user selects a folder, otherwise EFalse
1.276 + */
1.277 + IMPORT_C static TBool RunMoveDlgLD(
1.278 + TInt aIncludedMedias,
1.279 + TDes& aDirectory,
1.280 + TInt aMemorySelectionResourceId,
1.281 + const TDesC& aFileSelectionTitle,
1.282 + MAknFileSelectionObserver* aObserver = NULL );
1.283 +
1.284 + /**
1.285 + * A static method that launches move dialog.
1.286 + * @param aIncludedMedias defines which medias are included in the
1.287 + * dialog. See TMemoryTypes.
1.288 + * @param aDirectory Full path of the folder that user
1.289 + * selects is stored to this descriptor.
1.290 + * @param aMemorySelectionResourceId A resource id for memory selection
1.291 + * dialog
1.292 + * @param aFileSelectionResourceId A resource id for file selection
1.293 + * dialog
1.294 + * @param aObserver An observer which is asked, if set, to verify user's
1.295 + * selection.
1.296 + * @return Returns ETrue if user selects a folder, otherwise EFalse
1.297 + */
1.298 + IMPORT_C static TBool RunMoveDlgLD(
1.299 + TInt aIncludedMedias,
1.300 + TDes& aDirectory,
1.301 + TInt aMemorySelectionResourceId,
1.302 + TInt aFileSelectionResourceId,
1.303 + MAknFileSelectionObserver* aObserver = NULL );
1.304 +
1.305 + /**
1.306 + * A static method that launches save dialog which does not run folder
1.307 + * selection dialog at all. Instead the resulting path will be
1.308 + * constructed from the root and default folder read from resources and
1.309 + * from the file name given by the user.
1.310 + * @param aIncludedMedias defines which medias are included in the
1.311 + * dialog. See TMemoryTypes.
1.312 + * @param aDefaultFileName Full path + the filename that user enters
1.313 + * is stored to this descriptor. The descriptor may contain text
1.314 + * that is used as default filename, for example "Attachment".
1.315 + * @param aMemorySelectionResourceId A resource id for memory selection
1.316 + * dialog.
1.317 + * @param aObserver An observer which is asked, if set, to verify the
1.318 + * filename that user types.
1.319 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.320 + * EFalse.
1.321 + */
1.322 + IMPORT_C static TBool RunSaveDlgLD(
1.323 + TInt aIncludedMedias,
1.324 + TDes& aDefaultFileName,
1.325 + TInt aMemorySelectionResourceId,
1.326 + MAknFileSelectionObserver* aObserver = NULL );
1.327 +
1.328 + /**
1.329 + * A static method that launches save dialog.
1.330 + * @param aIncludedMedias defines which medias are included in the
1.331 + * dialog. See TMemoryTypes.
1.332 + * @param aDefaultFileName Full path + the filename that user enters
1.333 + * is stored to this descriptor. The descriptor may contain text
1.334 + * that is used as default filename, for example "Attachment".
1.335 + * @param aMemorySelectionResourceId A resource id for memory selection
1.336 + * dialog.
1.337 + * @param aFilter Filter is asked if a directory entry can be shown in
1.338 + * list. Ownership is not transferred.
1.339 + * @param aObserver An observer which is asked, if set, to verify the
1.340 + * filename that user types.
1.341 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.342 + * EFalse.
1.343 + */
1.344 + IMPORT_C static TBool RunSaveDlgLD(
1.345 + TInt aIncludedMedias,
1.346 + TDes& aDefaultFileName,
1.347 + TInt aMemorySelectionResourceId,
1.348 + MAknFileFilter* aFilter,
1.349 + MAknFileSelectionObserver* aObserver = NULL );
1.350 +
1.351 + /**
1.352 + * A static method that launches save dialog.
1.353 + * @param aIncludedMedias defines which medias are included in the
1.354 + * dialog. See TMemoryTypes.
1.355 + * @param aDefaultFileName Full path + the filename that user enters
1.356 + * is stored to this descriptor. The descriptor may contain text
1.357 + * that is used as default filename, for example "Attachment".
1.358 + * @param aMemorySelectionResourceId A resource id for memory selection
1.359 + * dialog.
1.360 + * @param aFileSelectionTitle Custom title for file selection dialog.
1.361 + * @param aFileNamePromptTitle Custom title for filename prompt dialog.
1.362 + * @param aObserver An observer which is asked, if set, to verify the
1.363 + * filename that user types.
1.364 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.365 + * EFalse.
1.366 + */
1.367 + IMPORT_C static TBool RunSaveDlgLD(
1.368 + TInt aIncludedMedias,
1.369 + TDes& aDefaultFileName,
1.370 + TInt aMemorySelectionResourceId,
1.371 + const TDesC& aFileSelectionTitle,
1.372 + const TDesC& aFileNamePromptTitle,
1.373 + MAknFileSelectionObserver* aObserver = NULL );
1.374 +
1.375 + /**
1.376 + * A static method that launches save dialog.
1.377 + * @param aIncludedMedias defines which medias are included in the
1.378 + * dialog. See TMemoryTypes.
1.379 + * @param aDefaultFileName Full path + the filename that user enters
1.380 + * is stored to this descriptor. The descriptor may contain text
1.381 + * that is used as default filename, for example "Attachment".
1.382 + * @param aMemorySelectionResourceId A resource id for memory selection
1.383 + * dialog.
1.384 + * @param aFileSelectionResourceId A resource id for file selection
1.385 + * dialog.
1.386 + * @param aObserver An observer which is asked, if set, to verify the
1.387 + * filename that user types.
1.388 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.389 + * EFalse.
1.390 + */
1.391 + IMPORT_C static TBool RunSaveDlgLD(
1.392 + TInt aIncludedMedias,
1.393 + TDes& aDefaultFileName,
1.394 + TInt aMemorySelectionResourceId,
1.395 + TInt aFileSelectionResourceId,
1.396 + MAknFileSelectionObserver* aObserver = NULL );
1.397 +
1.398 + /**
1.399 + * A static method that launches save dialog.
1.400 + * @param aIncludedMedias defines which medias are included in the
1.401 + * dialog. See TMemoryTypes.
1.402 + * @param aDefaultFileName Full path + the filename that user enters
1.403 + * is stored to this descriptor. The descriptor may contain text
1.404 + * that is used as default filename, for example "Attachment".
1.405 + * @param aMemorySelectionResourceId A resource id for memory selection
1.406 + * dialog.
1.407 + * @param aFileSelectionResourceId A resource id for file selection
1.408 + * dialog.
1.409 + * @param aFileNamePromptTitle Custom title for filename prompt dialog.
1.410 + * @param aObserver An observer which is asked, if set, to verify the
1.411 + * filename that user types.
1.412 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.413 + * EFalse.
1.414 + */
1.415 + IMPORT_C static TBool RunSaveDlgLD(
1.416 + TInt aIncludedMedias,
1.417 + TDes& aDefaultFileName,
1.418 + TInt aMemorySelectionResourceId,
1.419 + TInt aFileSelectionResourceId,
1.420 + const TDesC& aFileNamePromptTitle,
1.421 + MAknFileSelectionObserver* aObserver = NULL );
1.422 +
1.423 + /**
1.424 + * A static method that launches save dialog. No file selection dialog
1.425 + * for directory selection is displayed.
1.426 + * @param aIncludedMedias defines which medias are included in the
1.427 + * dialog. See TMemoryTypes.
1.428 + * @param aDefaultFileName Full path + the filename that user enters
1.429 + * is stored to this descriptor. The descriptor may contain text
1.430 + * that is used as default filename, for example "Attachment".
1.431 + * @param aMemorySelectionResourceId A resource id for memory selection
1.432 + * dialog. The folders in which the file will be saved should be
1.433 + * given in this resource.
1.434 + * @param aObserver An observer which is asked, if set, to verify the
1.435 + * filename that user types.
1.436 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.437 + * EFalse.
1.438 + */
1.439 + IMPORT_C static TBool RunSaveDlgNoDirectorySelectionLD(
1.440 + TInt aIncludedMedias,
1.441 + TDes& aDefaultFileName,
1.442 + TInt aMemorySelectionResourceId,
1.443 + MAknFileSelectionObserver* aObserver = NULL );
1.444 +
1.445 + /**
1.446 + * A static method that launches save dialog. No file selection dialog
1.447 + * for directory selection is displayed.
1.448 + * @param aIncludedMedias defines which medias are included in the
1.449 + * dialog. See TMemoryTypes.
1.450 + * @param aDefaultFileName Full path + the filename that user enters
1.451 + * is stored to this descriptor. The descriptor may contain text
1.452 + * that is used as default filename, for example "Attachment".
1.453 + * @param aMemorySelectionResourceId A resource id for memory selection
1.454 + * dialog. The folders in which the file will be saved should be
1.455 + * given in this resource.
1.456 + * @param aFileNamePromptTitle Custom title for filename prompt dialog.
1.457 + * @param aObserver An observer which is asked, if set, to verify the
1.458 + * filename that user types.
1.459 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.460 + * EFalse.
1.461 + */
1.462 + IMPORT_C static TBool RunSaveDlgNoDirectorySelectionLD(
1.463 + TInt aIncludedMedias,
1.464 + TDes& aDefaultFileName,
1.465 + TInt aMemorySelectionResourceId,
1.466 + const TDesC& aFileNamePromptTitle,
1.467 + MAknFileSelectionObserver* aObserver = NULL );
1.468 +
1.469 + /**
1.470 + * A static method that launches copy dialog.
1.471 + * @param aIncludedMedias defines which medias are included in the
1.472 + * dialog. See TMemoryTypes.
1.473 + * @param aDirectory Full path of the folder that user
1.474 + * selects is stored to this descriptor.
1.475 + * @param aMemorySelectionResourceId A resource id for memory selection
1.476 + * dialog.
1.477 + * @param aObserver An observer which is asked, if set, to verify user's
1.478 + * selection.
1.479 + * @return Returns ETrue if user selects a folder, otherwise EFalse.
1.480 + */
1.481 + IMPORT_C static TBool RunCopyDlgLD(
1.482 + TInt aIncludedMedias,
1.483 + TDes& aDirectory,
1.484 + TInt aMemorySelectionResourceId,
1.485 + MAknFileSelectionObserver* aObserver = NULL );
1.486 +
1.487 +
1.488 + /**
1.489 + * A static method that launches copy dialog.
1.490 + * @param aIncludedMedias defines which medias are included in the
1.491 + * dialog. See TMemoryTypes.
1.492 + * @param aDirectory Full path of the folder that user
1.493 + * selects is stored to this descriptor.
1.494 + * @param aMemorySelectionResourceId A resource id for memory selection
1.495 + * dialog.
1.496 + * @param aFilter Filter is asked if a directory entry can be shown in
1.497 + * list. Ownership is not transferred.
1.498 + * @param aObserver An observer which is asked, if set, to verify user's
1.499 + * selection.
1.500 + * @return Returns ETrue if user selects a folder, otherwise EFalse.
1.501 + */
1.502 + IMPORT_C static TBool RunCopyDlgLD(
1.503 + TInt aIncludedMedias,
1.504 + TDes& aDirectory,
1.505 + TInt aMemorySelectionResourceId,
1.506 + MAknFileFilter* aFilter,
1.507 + MAknFileSelectionObserver* aObserver = NULL );
1.508 +
1.509 + /**
1.510 + * A static method that launches copy dialog.
1.511 + * @param aIncludedMedias defines which medias are included in the
1.512 + * dialog. See TMemoryTypes.
1.513 + * @param aDirectory Full path of the folder that user
1.514 + * selects is stored to this descriptor.
1.515 + * @param aMemorySelectionResourceId A resource id for memory selection
1.516 + * dialog
1.517 + * @param aFileSelectionResourceId A resource id for file selection
1.518 + * dialog
1.519 + * @param aObserver An observer which is asked, if set, to verify user's
1.520 + * selection.
1.521 + * @return Returns ETrue if user selects a folder, otherwise EFalse
1.522 + */
1.523 + IMPORT_C static TBool RunCopyDlgLD(
1.524 + TInt aIncludedMedias,
1.525 + TDes& aDirectory,
1.526 + TInt aMemorySelectionResourceId,
1.527 + TInt aFileSelectionResourceId,
1.528 + MAknFileSelectionObserver* aObserver = NULL );
1.529 +
1.530 + /**
1.531 + * A static method that launches file selection dialog.
1.532 + * @param aIncludedMedias defines which medias are included in the
1.533 + * dialog. See TMemoryTypes.
1.534 + * @param aFileName Full path and filename of the file that user
1.535 + * selects is stored to this descriptor.
1.536 + * @param aStartFolder User defined folder to start browsing in file
1.537 + * selection.
1.538 + * @param aMemorySelectionResourceId A resource id for memory selection
1.539 + * dialog.
1.540 + * @param aObserver An observer which is asked, if set, to verify user's
1.541 + * selection.
1.542 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.543 + * @since 3.2
1.544 + */
1.545 + IMPORT_C static TBool RunSelectDlgLD(
1.546 + TInt aIncludedMedias,
1.547 + TDes& aFileName,
1.548 + const TDesC& aStartFolder,
1.549 + TInt aMemorySelectionResourceId,
1.550 + MAknFileSelectionObserver* aObserver = NULL );
1.551 +
1.552 + /**
1.553 + * A static method that launches file selection dialog.
1.554 + * @param aIncludedMedias defines which medias are included in the
1.555 + * dialog. See TMemoryTypes.
1.556 + * @param aFileName Full path and filename of the file that user
1.557 + * selects is stored to this descriptor.
1.558 + * @param aStartFolder User defined folder to start browsing in file
1.559 + * selection
1.560 + * @param aMemorySelectionResourceId A resource id for memory selection
1.561 + * dialog.
1.562 + * @param aFilter Filter is asked if a directory entry can be shown in
1.563 + * list. Ownership is not transferred.
1.564 + * @param aObserver An observer which is asked, if set, to verify user's
1.565 + * selection.
1.566 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.567 + * @since 3.2
1.568 + */
1.569 + IMPORT_C static TBool RunSelectDlgLD(
1.570 + TInt aIncludedMedias,
1.571 + TDes& aFileName,
1.572 + const TDesC& aStartFolder,
1.573 + TInt aMemorySelectionResourceId,
1.574 + MAknFileFilter* aFilter,
1.575 + MAknFileSelectionObserver* aObserver = NULL );
1.576 +
1.577 + /**
1.578 + * A static method that launches file selection dialog.
1.579 + * @param aIncludedMedias defines which medias are included in the
1.580 + * dialog. See TMemoryTypes.
1.581 + * @param aFileName Full path and filename of the file that user
1.582 + * selects is stored to this descriptor.
1.583 + * @param aStartFolder User defined folder to start browsing in file
1.584 + * selection
1.585 + * @param aMemorySelectionResourceId A resource id for memory selection
1.586 + * dialog.
1.587 + * @param aFileSelectionTitle A custom title for file selection dialog.
1.588 + * @param aObserver An observer which is asked, if set, to verify user's
1.589 + * selection.
1.590 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.591 + * @since 3.2
1.592 + */
1.593 + IMPORT_C static TBool RunSelectDlgLD(
1.594 + TInt aIncludedMedias,
1.595 + TDes& aFileName,
1.596 + const TDesC& aStartFolder,
1.597 + TInt aMemorySelectionResourceId,
1.598 + const TDesC& aFileSelectionTitle,
1.599 + MAknFileSelectionObserver* aObserver = NULL );
1.600 +
1.601 + /**
1.602 + * A static method that launches file selection dialog.
1.603 + * @param aIncludedMedias defines which medias are included in the
1.604 + * dialog. See TMemoryTypes.
1.605 + * @param aFileName Full path and filename of the file that user
1.606 + * selects is stored to this descriptor.
1.607 + * @param aStartFolder User defined folder to start browsing in file
1.608 + * selection
1.609 + * @param aMemorySelectionResourceId A resource id for memory selection
1.610 + * dialog.
1.611 + * @param aFileSelectionResourceId A resource id for file selection
1.612 + * dialog.
1.613 + * @param aObserver An observer which is asked, if set, to verify user's
1.614 + * selection.
1.615 + * @return Returns ETrue if user selects a file, otherwise EFalse.
1.616 + * @since 3.2
1.617 + */
1.618 + IMPORT_C static TBool RunSelectDlgLD(
1.619 + TInt aIncludedMedias,
1.620 + TDes& aFileName,
1.621 + const TDesC& aStartFolder,
1.622 + TInt aMemorySelectionResourceId,
1.623 + TInt aFileSelectionResourceId,
1.624 + MAknFileSelectionObserver* aObserver = NULL );
1.625 +
1.626 + /**
1.627 + * A static method that launches file selection dialog.
1.628 + * @param aIncludedMedias defines which medias are included in the
1.629 + * dialog. See TMemoryTypes.
1.630 + * @param aFileName Full path and filename of the file that user selects is
1.631 + * stored to this descriptor.
1.632 + * @param aStartFolder User defined folder to start browsing in file
1.633 + * selection.
1.634 + * @param aMemorySelectionResourceId A resource id for memory selection
1.635 + * dialog.
1.636 + * @param aFileSelectionResourceId A resource id for file selection dialog.
1.637 + * @param aFileSelectionTitle Custom title for file selection dialog.
1.638 + * @param aFilter Filter asked if a directory entry can be shown in list.
1.639 + * @param aObserver An observer which is asked to verify user's selection.
1.640 + * @return Returns ETrue if user selects a file, otherwise EFalse
1.641 + * @since 3.2
1.642 + */
1.643 + IMPORT_C static TBool RunSelectDlgLD(
1.644 + TInt aIncludedMedias,
1.645 + TDes& aFileName,
1.646 + const TDesC& aStartFolder,
1.647 + TInt aMemorySelectionResourceId,
1.648 + TInt aFileSelectionResourceId,
1.649 + const TDesC& aFileSelectionTitle,
1.650 + MAknFileFilter* aFilter = NULL,
1.651 + MAknFileSelectionObserver* aObserver = NULL );
1.652 +
1.653 + /**
1.654 + * A static method that launches save dialog.
1.655 + * @param aIncludedMedias defines which medias are included in the
1.656 + * dialog. See TMemoryTypes.
1.657 + * @param aDefaultFileName Full path + the filename that user enters
1.658 + * is stored to this descriptor. The descriptor may contain text
1.659 + * that is used as default filename, for example "Attachment".
1.660 + * @param aStartFolder User defined folder to start browsing in file
1.661 + * selection.
1.662 + * @param aMemorySelectionResourceId A resource id for memory selection
1.663 + * dialog.
1.664 + * @param aFileSelectionResourceId A resource id for file selection dialog.
1.665 + * @param aFileSelectionTitle Custom title for file selection dialog.
1.666 + * @param aFilter Filter asked if a directory entry can be shown in list.
1.667 + * @param aObserver An observer which is asked, if set, to verify the
1.668 + * filename that user types.
1.669 + * @return Returns ETrue if user accepts or enters a filename, otherwise
1.670 + * EFalse.
1.671 + * @since 3.2
1.672 + */
1.673 + IMPORT_C static TBool RunSaveDlgLD(
1.674 + TInt aIncludedMedias,
1.675 + TDes& aDefaultFileName,
1.676 + const TDesC& aStartFolder,
1.677 + TInt aMemorySelectionResourceId,
1.678 + TInt aFileSelectionResourceId,
1.679 + const TDesC& aFileSelectionTitle,
1.680 + MAknFileFilter* aFilter = NULL,
1.681 + MAknFileSelectionObserver* aObserver = NULL );
1.682 +
1.683 + /**
1.684 + * A static method that launches folder selection dialog.
1.685 + * @param aIncludedMedias defines which medias are included in the
1.686 + * dialog. See TMemoryTypes.
1.687 + * @param aFolder Full path of the folder that user selects is stored to
1.688 + * this descriptor.
1.689 + * @param aStartFolder User defined folder to start browsing in file
1.690 + * selection.
1.691 + * @param aMemorySelectionResourceId A resource id for memory selection
1.692 + * dialog.
1.693 + * @param aFileSelectionResourceId A resource id for file selection dialog.
1.694 + * @param aFileSelectionTitle Custom title for file selection dialog.
1.695 + * @param aFilter Filter is asked if a directory entry can be shown in
1.696 + * list.
1.697 + * @param aObserver An observer which is asked to verify user's selection.
1.698 + * @return Returns ETrue if user selects a folder, otherwise EFalse
1.699 + * @since 3.2
1.700 + */
1.701 + IMPORT_C static TBool RunFolderSelectDlgLD(
1.702 + TInt aIncludedMedias,
1.703 + TDes& aFolder,
1.704 + const TDesC& aStartFolder,
1.705 + TInt aMemorySelectionResourceId,
1.706 + TInt aFileSelectionResourceId,
1.707 + const TDesC& aFileSelectionTitle,
1.708 + MAknFileFilter* aFilter = NULL,
1.709 + MAknFileSelectionObserver* aObserver = NULL );
1.710 +
1.711 +private:
1.712 +
1.713 + /**
1.714 + * A static method that launches UI components in a sequence.
1.715 + * @param aType Defines what type of dialog is shown.
1.716 + * @param aFileName A reference to a descriptor. Usage depends on the
1.717 + * dialog type.
1.718 + * @param aMemorySelectionResourceId A resource id for memory selection
1.719 + * dialog.
1.720 + * @param aNoFileSelectionDialog, if ETrue and aType is ECFDDialogType-
1.721 + * Save, no file selection dialog is launched, instead the file
1.722 + * will be saved in the default folder given in the resource
1.723 + * structure referred by aMemorySelectionResourceId.
1.724 + * @param aFileSelectionResourceId A resource id for file selection
1.725 + * dialog.
1.726 + * @param aFileNamePromptResourceId A resource id for filename prompt
1.727 + * dialog.
1.728 + * @param aFileSelectionTitle Custom title for file selection.
1.729 + * @param aFileNamePromptTitle Custom title for filename prompt dialog.
1.730 + * @param aFileFilter Filter is asked if a directory entry can be shown
1.731 + * in list.
1.732 + * @param aMemorySelectionObserver An observer for memory selection
1.733 + * dialog.
1.734 + * @param aFileSelectionObserver An observer for file selection dialog.
1.735 + * @param aFileNamePromptObserver An observer for filename prompt
1.736 + * dialog.
1.737 + * @param aStartFolder User defined folder to start browsing in file
1.738 + * selection
1.739 + * @param aIncludedMedias defines which medias are included in the
1.740 + * dialog. See TMemoryTypes
1.741 + * @return Returns a boolean value that depends on the case.
1.742 + */
1.743 + static TBool RunL(
1.744 + TCommonDialogType aType,
1.745 + TDes& aFileName,
1.746 + TInt aMemorySelectionResourceId,
1.747 + TBool aNoFileSelectionDialog,
1.748 + TInt aFileSelectionResourceId,
1.749 + TInt aFileNamePromptResourceId,
1.750 + const TDesC& aFileSelectionTitle,
1.751 + const TDesC& aFileNamePromptTitle,
1.752 + MAknFileFilter* aFileFilter,
1.753 + MAknMemorySelectionObserver* aMemorySelectionObserver,
1.754 + MAknFileSelectionObserver* aFileSelectionObserver,
1.755 + MAknFileSelectionObserver* aFileNamePromptObserver,
1.756 + const TDesC& aStartFolder,
1.757 + TInt aIncludedMedias );
1.758 +
1.759 + };
1.760 +
1.761 +#endif // AKNCOMMONDIALOGSDYNMEM_H