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