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