classicui_plat/common_file_dialogs_api/inc/CommonDialogs.rh
author hgs
Thu, 29 Jul 2010 14:21:56 +0800
changeset 46 0e1e0022bd03
permissions -rw-r--r--
201029_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     1
/*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     3
* All rights reserved.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     8
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    11
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    12
* Contributors:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    13
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    14
* Description:  This file contains declarations for resources of
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    15
*                Common File Dialogs. The file can be included only in
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    16
*                resource file.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    17
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    18
*/
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    19
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    20
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    21
//  INCLUDES
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    22
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    23
//  STRUCTURE DEFINITIONS
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    24
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    25
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    26
//    FILTER
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    27
//    FILTER is a resource structure for filter definition.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    28
//    "filter_type" defines if the filter is an attribute or a filename filter.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    29
//    "filter_style" defines if the filter is an inclusive or an exclusive filter.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    30
//    Inclusive filter doesn't accept anything but the files and folders (entries)
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    31
//    that match with the filter. Exclusive filter accepts only those entries
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    32
//    that match with the filter.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    33
//    "filter_data" is an array of strings:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    34
//    In filename filter data is wildcards ("*.jpg", "*.gif", ...).
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    35
//    In attribute filter data is first letters of attributes
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    36
//    ("R", "H", "S", ... or "RHS").
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    37
//    The attributes in Symbian OS file system are:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    38
//    Read only, Hidden, System, Volume, Directory and Archive
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    39
//    Note! Files and directories with System attribute are always hidden
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    40
//    from user.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    41
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    42
//
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    43
STRUCT FILTER
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    44
	{
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    45
	WORD filter_type;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    46
	WORD filter_style;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    47
	LTEXT filter_data[];
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    48
	}
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    49
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    50
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    51
//    LOCATION
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    52
//    LOCATION is a resource structure that defines a root path and a default folder.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    53
//    "root_path" is the absolute path to be considered as root when browsing.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    54
//    e.g. "C:\\Nokia\\"
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    55
//    "default_folder" is the folder where browsing is started.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    56
//    e.g. "Images\\Pictures\\"
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    57
//    Note! Do not put folder names in .LOC file! These are
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    58
//    physical file system paths. Possible localization is done
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    59
//    in the DLL.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    60
//    Note! Remeber to use trailing backslash!
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    61
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    62
//
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    63
STRUCT LOCATION
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    64
	{
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    65
	LTEXT root_path;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    66
	LTEXT default_folder;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    67
	}
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    68
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    69
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    70
//   MEMORYSELECTIONDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    71
//   MEMORYSELECTIONDIALOG is a resource structure for memory selection dialog.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    72
//   In this structure a title and texts for softkeys can be defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    73
//   "title" is "Select memory:" by default if it is not defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    74
//   Locations of the memories can be defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    75
//   NOTE: Locations for memory selection dialog is deprecated. Only use it
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    76
//         when using TMemory parameter in CAknMemorySelectionDialog
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    77
//   @see CAknMemorySelectionDialog
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    78
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    79
//
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    80
STRUCT MEMORYSELECTIONDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    81
	{
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    82
	LTEXT title;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    83
	LTEXT softkey_1;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    84
	LTEXT softkey_2;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    85
	STRUCT locations[]; // LOCATION
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    86
	}
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    87
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    88
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    89
//    FILESELECTIONDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    90
//    This is a resource structure for file selection dialog.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    91
//    In this structure a title and texts for softkeys can be defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    92
//    "title" is "Select from:" by default if it is not defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    93
//    "softkey_1_file" is shown when a file is focused.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    94
//    "softkey_1_folder" is shown when a folder is focused.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    95
//    "softkey_2_root_level" is shown when user is browsing in the first level (root folder).
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    96
//    "softkey_2_subfolder" is shown when user is browsing in a subfolder
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    97
//    "root_path" and "default_folder" can be defined. They are explained in LOCATION struct.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    98
//    Filters can be defined with FILTER structures.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    99
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   100
//
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   101
STRUCT FILESELECTIONDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   102
	{
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   103
	LTEXT title;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   104
	LTEXT softkey_1_file;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   105
	LTEXT softkey_1_folder;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   106
	LTEXT softkey_2_root_level;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   107
	LTEXT softkey_2_subfolder;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   108
	LTEXT root_path;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   109
	LTEXT default_folder;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   110
	STRUCT filters[]; // FILTER structs
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   111
	}
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   112
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   113
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   114
//    FILENAMEPROMPTDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   115
//    A structure for prompting a single filename.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   116
//    In this structure a title and texts for softkeys can be defined.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   117
//    "default_filename" defines the default filename. Extension is not shown.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   118
//    "path" is the path that the file is supposed to save.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   119
//    If path is set, it can be checked if file already exists.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   120
// ---------------------------------------------------------
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   121
//
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   122
STRUCT FILENAMEPROMPTDIALOG
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   123
	{
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   124
	LTEXT filename_prompt; // title
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   125
	LTEXT default_filename;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   126
	LTEXT path;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   127
	LTEXT softkey_1;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   128
	LTEXT softkey_2;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   129
	}
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   130
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
   131
// End of File