Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
2 * Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * 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
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
14 * Description: Resource structure definitions for Avkon.
23 #if !defined(__BADEF_RH__)
27 #if !defined(__UIKON_HRH__)
31 STRUCT AVKON_SYSTEM_FONT
33 LONG fontuid; // a value from fontids.hrh
34 STRUCT named_font; // this must be a NAMED_FONT structure type
39 WORD type=ENaviDecoratorControlNone;
60 WORD tab_width = EAknTabWidthWithTwoTabs; // two tabs
61 WORD active = 0; // index of the first active tab
104 WORD npriority=0xffff;
105 WORD wpriority=0xffff;
110 STRUCT INDICATOR_STATE
116 STRUCT INDICATOR_ICON
118 WORD narrowbmpid=0xffff;
119 WORD narrowbmpmask=0xffff;
120 WORD widebmpid=0xffff;
121 WORD widebmpmask=0xffff;
126 BYTE version=0; // resource struct version, do not change.
131 LLINK extension=0; // reserved for future extensions
137 LTEXT singular_label;
138 LTEXT plural_label="";
141 WORD imagemask=0xffff;
144 WORD iconmask=0xffff;
146 WORD flags=0; //TNoteFlags (defined in aknnoteattributes.h)
149 STRUCT NOTE_COMPONENT
163 STRUCT AVKON_CONFIRMATION_QUERY
173 STRUCT AVKON_DATA_QUERY
180 STRUCT AVKON_MESSAGE_QUERY
185 STRUCT AVKON_MULTI_LINE_DATA_QUERY
195 // use this with CAknQueryDialog.
196 // This is for one dialog DLG line with EAknCtListQueryControl
198 // The list query window type is determined from EAknCtSinglePopupMenuListBox - if you want to
199 // have your own borders, derive from CAknListQueryDialog and override some methods.
201 STRUCT AVKON_LIST_QUERY_CONTROL
203 WORD listtype; // type of the list, for example EAknCtSinglePopupMenuListBox (window type is determined from this)
204 STRUCT listbox; // LISTBOX resource, use AVKON_LIST_QUERY_LIST or AVKON_MULTISELECTION_LIST_QUERY_LIST
214 LTEXT label = ""; // default is no heading
219 LLINK headinglayout = R_AVKON_LIST_HEADING_PANE;
225 WORD flags=0; // permitted flags: EAknPopupFieldFlagAllowsUserDefinedEntry
226 WORD width=0; // in characters
227 LTEXT other=""; // if non-empty, replaces
228 LLINK emptynote = 0; // note to be displayed if popupfield is empty
229 LTEXT empty=""; // text to display if popupfield is empty
230 LTEXT invalid = ""; // text to display if popupfield is invalid
233 STRUCT POPUP_FIELD_TEXT
235 STRUCT popupfield; // only use POPUP_FIELD here
236 LLINK textarray = 0; // resource ID of an array of text
237 WORD active = 0; // zero based, item in textarray to be initially selected
240 STRUCT POPUP_FIELD_SELECTION_BMP
244 WORD bmpmaskon=0xffff;
245 WORD bmpidoff=0xffff;
246 WORD bmpmaskoff=0xffff;
255 WORD valuetype=EAknSliderValueBareFigure;
256 WORD decimalplaces=0;
257 LTEXT singular_valuelabel = "";
261 LLINK graphical_image=0;
264 /** used with CAknVolumeControl
265 * see avkon.hrh for the flag definitions
266 * This struct uses default values for volume range:
267 * ESettingsVolumeControl, EDynRangeSettingsVolumeControl: 1-10
268 * ENaviPaneVolumeControl, EPopupVolumeControl, EDynRangeNaviPaneVolumeControl,
269 * EDynRangePopupVolumeControl, ESmallPopupVolumeControl,
270 * ESmallPopupVolumeControlWithPercent: 0-10
281 /** used with CAknVolumeControl
282 * This struct is used with flags defined in
283 * TAknVolumeControlDynamicLayouts
284 * see avkon.hrh for the flag definitions
287 STRUCT DYNAMIC_VOLUME
289 WORD identifier = 0xffff; // Do not change
301 WORD num_code_chars=8;
306 WORD layoutflags = 0;
307 WORD primaryscroll = 0;
308 WORD secondaryscroll = 0;
309 WORD itemsinprimaryorient = 0;
310 WORD itemsinsecondaryorient = 0;
321 WORD height = 5; // in items
322 WORD width = 10; // in chars
324 LTEXT emptytext = "";
328 STRUCT AVKON_SETTING_PAGE
330 WORD number = EAknSettingPageNoOrdinalDisplayed;
333 LLINK softkey_resource = 0;
336 LLINK editor_resource_id = 0;
337 LLINK invalid_contents_softkey_resource = 0;
341 STRUCT AVKON_SETTING_ITEM_LIST
343 WORD flags = 0; // Allowed values: EAknSettingItemListNumberedStyle
345 WORD initial_number = 1;
349 STRUCT AVKON_SETTING_ITEM
353 LLINK setting_page_resource = 0;
355 LLINK setting_editor_resource = 0;
356 LLINK associated_resource = 0;
357 LTEXT empty_item_text = "";
358 LTEXT compulsory_ind_string = "";
359 LLINK reserved = 0; // Added for extensions
362 STRUCT AVKON_PASSWORD_CONFIRMATION
364 LLINK password_query_resource = 0;
365 LLINK success_note_resource = 0;
366 LLINK failure_note_resource = 0;
369 STRUCT AVKON_ENUMERATED_TEXT
375 STRUCT AVKON_POPUP_SETTING_TEXTS
378 LLINK setting_texts_resource = 0;
379 LLINK popped_up_texts_resource = 0;
383 STRUCT AVKON_SEARCH_FIELD
387 STRUCT AVKON_LISTBOX_LINES
397 BYTE identifier = 0; // Do not change, used to identify the used resource struct.
398 WORD frameinterval = -1;
403 LLINK backgroundframe = 0;
415 // Resource-based layout resources (Deprecated)
416 // These does not define absolute coordinates => resizing these layouts is possible!
418 // (those which does not mention column or form in their name could be used later by
419 // other controls for their layout - there will be generic resource reader for these)
421 // this is used with listboxes
422 STRUCT AVKON_LB_LAYOUT_POS
432 // this is used with listboxes too
433 STRUCT AVKON_LB_LAYOUT_GFX
445 // This is used with listboxes
446 STRUCT AVKON_LB_LAYOUT_TEXT
449 WORD font; WORD C; WORD lm; WORD rm; WORD B; WORD W; WORD align;
452 // This is used with CAknLayoutUtils::LayoutControl()
453 STRUCT AVKON_LAYOUT_CONTROL
464 // This is used with TAknLayoutRect
465 STRUCT AVKON_LAYOUT_RECT
476 // this is used with AknListBoxLayouts::LayoutImage
477 #define AVKON_LAYOUT_IMAGE AVKON_LAYOUT_RECT
479 STRUCT AVKON_LAYOUT_TEXT
490 // This should be used with CAknLayoutUtils::LayoutEdwin
491 STRUCT AVKON_LAYOUT_EDWIN
500 WORD lines=1; // Number of lines shown
501 WORD nextB=0; // Second row's baseline position
504 // This can be used with CAknLayoutUtils::LayoutLabel to layout CEikLabel's.
505 STRUCT AVKON_LAYOUT_LABEL
517 // This is used with CAknLayoutUtils::LayoutPopupField()
518 STRUCT AVKON_LAYOUT_FORM_FIELD_POPUP_PANE
521 WORD C = ELayoutEmpty;
522 WORD l = ELayoutEmpty;
523 WORD t = ELayoutEmpty;
524 WORD r = ELayoutEmpty;
525 WORD b = ELayoutEmpty;
526 WORD W = ELayoutEmpty;
527 WORD H1 = ELayoutEmpty;
528 WORD H2 = ELayoutEmpty;
529 WORD H3 = ELayoutEmpty;
530 WORD H4 = ELayoutEmpty;
531 WORD H5 = ELayoutEmpty;
532 WORD H6 = ELayoutEmpty;
533 WORD lines = 1; // Number of lines shown
536 STRUCT AVKON_LB_LAYOUT_AREA
543 STRUCT AVKON_LB_LAYOUT_COMMAND
550 // This is only for listboxes, use
551 // AknLayoutUtils/TAknLayoutText/TAknLayoutRect for getting correct layouts.
552 STRUCT AVKON_LAYOUT_MANAGER
554 STRUCT gfx[]; // AVKON_LAYOUT_GFX
555 STRUCT text[]; // AVKON_LAYOUT_TEXT
556 STRUCT cmds[]; // AVKON_LAYOUT_COMMAND
557 STRUCT area[]; // AVKON_LAYOUT_AREA
558 STRUCT pos; // AVKON_LAYOUT_POS
561 // This should be used with AknEditUtils::ConstructEditingL
562 STRUCT AVKON_CONFIG_EDWIN
564 WORD editingSpace; // Max number of character in a editor field
565 WORD editingWindow; // Maximum number of lines in a editor field
566 WORD characterCase; // EAknEditorCharactersUpperCase, EAknEditorCharactersLowerCase, EAknEditorCharactersTextCase
567 WORD justification; // EAknEditorAlignNone, EAknEditorAlignCenter, EAknEditorAlignLeft, EAknEditorAlignRight
568 WORD allowedToMoveInsertionPoint;
573 STRUCT AVKON_CBA_BUTTON
575 BYTE version=KAknCbaVersion;
580 WORD bmpid=0xffff; // -1
581 WORD bmpmask=0xffff; // -1
584 // Special Character Table
586 STRUCT SPECIAL_CHAR_TABLE
588 STRUCT contents[]; // SCT_CHAR_SET
597 // ---------------------------------------------------------
598 // Resource structure for CAknIconArray class.
599 // ---------------------------------------------------------
601 STRUCT AKN_ICON_ARRAY
603 WORD type = EAknIconArraySimple;
606 // Array of AKN_ICON structures.
610 STRUCT AKN_ICON_ARRAY_ARRAY
612 WORD type = EAknIconArrayComplex;
613 STRUCT iconarrays[]; // AKN_ICON_ARRAY
616 // ---------------------------------------------------------
617 // One icon in AKN_ICON_ARRAY
618 // ---------------------------------------------------------
622 // Id of the icon bitmap
624 // Id of the mask bitmap
630 STRUCT AVKON_SOUND_INFO
632 WORD signature1 = 0x1234;
633 WORD signature2 = 0x5678;
635 WORD priority = EAvkonKeyClickPriority;
636 LONG preference = EAvkonKeyClickPreference;
640 WORD sequencelength=0;
642 BYTE volume=9; // default to loudest value
645 STRUCT AVKON_SOUND_INFO_LIST
650 STRUCT AVKON_SKEY_INFO
652 WORD sid = EAvkonSIDDefaultSound;
654 BYTE type = ESKeyTypeShort;
657 STRUCT AVKON_SKEY_LIST
662 STRUCT PHONE_NUMBER_EDITOR
670 STRUCT PHONE_NUMBER_EDITOR_FORMAT
678 WORD bottomBaselineOffset;
679 WORD baselineSeparation;
683 // CAknPopupSettingList
684 STRUCT POPUP_SETTING_LIST
686 WORD flags; // permitted flags: EAknPopupSettingListFlagAllowsUserDefinedEntry
687 WORD width; // in characters.
688 LTEXT other="Other ...";
689 LTEXT empty_text="No options";
690 LLINK new_item_setting_page_resource = 0; // These 3 to allow setting page launch from list pane
692 LLINK new_item_setting_editor_resource = 0;
695 // This comes from DIALOG resource and must be updates accordingly when
696 // DIALOG resource is changed. see eikon.rh
697 STRUCT AVKON_LIST_QUERY
699 LONG flags = EGeneralQueryFlags;
702 LLINK softkeys = R_AVKON_SOFTKEYS_OK_CANCEL__OK; // CBA
703 STRUCT items[]; // AVKON_LIST_QUERY_DLG_LINE
707 STRUCT AVKON_MULTISELECTION_LIST_QUERY
709 LONG flags = EGeneralQueryFlags;
712 LLINK softkeys = R_AVKON_SOFTKEYS_OK_CANCEL__MARK; // CBA
713 STRUCT items[]; // AVKON_MULTISELECTION_LIST_QUERY_DLG_LINE
717 STRUCT AVKON_LIST_QUERY_DLG_LINE
719 WORD type = EAknCtListQueryControl;
721 WORD id = EListQueryControl;
723 STRUCT control; // AVKON_LIST_QUERY_CONTROL
727 WORD bmpmask = 0xffff;
731 STRUCT AVKON_MULTISELECTION_LIST_QUERY_DLG_LINE
733 WORD type = EAknCtListQueryControl;
735 WORD id = EListQueryControl;
737 STRUCT control; // AVKON_LIST_QUERY_CONTROL
741 WORD bmpmask = 0xffff;
745 STRUCT AVKON_LIST_QUERY_LIST
748 LONG flags = EAknListBoxMenuList;
754 STRUCT AVKON_MULTISELECTION_LIST_QUERY_LIST
757 LONG flags = EAknListBoxStylusMultiselectionList;
763 // LISTBOX resources:
764 STRUCT AVKON_SELECTION_LIST
767 LONG flags = EAknListBoxSelectionList;
772 STRUCT AVKON_MARKABLE_LIST
775 LONG flags = EAknListBoxMarkableList;
781 STRUCT AVKON_MULTISELECTION_LIST
784 LONG flags = EAknListBoxMultiselectionList;
790 STRUCT AVKON_MENU_LIST
793 LONG flags = EAknListBoxMenuList;
799 STRUCT AVKON_INTEGER_EDWIN
802 LONG min = -99999999;
804 LONG unset_value = -100000000;
805 LLINK extension1 = 0;
806 LLINK extension2 = 0;
809 // Avkon note wrappers
811 STRUCT AKN_NOTE_WRAPPER
813 // Id of the dialog resource for this note
815 // see TAknNoteDialogTimeout
817 // see TAknNoteDialogTone
823 STRUCT AVKON_GROUPED_NOTE_TEXTS
825 LLINK singular_label; // must point to resource of type TBUF
826 LLINK plural_label; // must point to resource of type TBUF
827 WORD flags = 0; // for future proofing
831 STRUCT AKN_SELECTION_LIST
833 WORD flags = 0; // see avkon.hrh / EAknFlagFind etc..
834 WORD listbox = EAknCtSingleListBox; // listbox layout
835 LLINK menubar = 0; // MENUBAR resource
836 LLINK dialogresource = R_AKN_SELECTION_LIST_DIALOG;
843 STRUCT AVKON_COLOUR_SELECTION_GRID
846 STRUCT gridcontrol; // GRID
849 STRUCT AVKON_LIST_QUERY_CONTROL_WITH_MSGBOX
851 WORD listtype = EAknListQueryWithMsgBox;
858 WORD bmpmask = 0xffff;
862 // resource structures for CAknStylusActivatedPopUpContent
863 STRUCT AVKON_STYLUSACTIVATEDPOPUP_CONTENT
865 LTEXT titletext = "";
868 STRUCT cmdlinks[]; // AVKON_STYLUSACTIVATEDPOPUP_LINK
869 LLINK extension = 0; // for future extensions
872 STRUCT AVKON_STYLUSACTIVATEDPOPUP_LINK
874 BYTE linkid; // use TAknStylusPopupCmdLinkIds, see avkon.hrh
876 LLINK extension = 0; // for future extensions
879 // Skinned bitmap Animation
880 // Always use BMPANIM_FRAME_SKINNED with BMPANIM_DATA_SKINNED
881 STRUCT BMPANIM_DATA_SKINNED
883 BYTE identifier = KAknBMPAnimVersion; // Do not change, used to identify the used resource struct.
884 LLINK skinanimationid = -1; // First try to create animation by using this id
885 WORD frameinterval = -1;
890 LLINK backgroundframe = 0;
893 STRUCT BMPANIM_FRAME_SKINNED
900 LLINK majorskinid = -1;
901 LLINK minorskinid = -1;
904 // ---------------------------------------------------------------------------
905 // SCT CATEGORY BUTTONS resources:
906 // define the category button(s)
907 // ---------------------------------------------------------------------------
909 STRUCT AVKON_SCT_CATEGORY_BUTTONS
911 STRUCT category_buttons[]; // AVKON_SCT_CATEGORY_BUTTON
914 // ---------------------------------------------------------------------------
915 // SCT CATEGORY BUTTON resources
916 // define a category button
917 // ---------------------------------------------------------------------------
919 STRUCT AVKON_SCT_CATEGORY_BUTTON
921 WORD categorybuttonid; // TAknSCTCategoryButtons (defined on avkon.hrh)
922 WORD id; // SCT enumerations (e.g. EAknSCTHalfCase) (defined on avkon.hrh)
923 LLINK button; // AVKON_BUTTON
926 // ---------------------------------------------------------------------------
927 // AVKON_NOTE_SKINNED
928 // Struct for defining a skinnable Avkon note, otherwise similar as AVKON_NOTE.
930 // ---------------------------------------------------------------------------
932 STRUCT AVKON_NOTE_SKINNED
934 WORD layout; // Layout.
935 LTEXT singular_label; // Singular label.
936 LTEXT plural_label = ""; // Plural label.
937 LTEXT imagefile = ""; // Image file name (including path).
938 WORD imageid = 0xffff; // Image id.
939 WORD imagemask = 0xffff; // Image mask.
940 LTEXT iconfile = ""; // Icon file name (including path).
941 WORD iconid = 0xffff; // Icon id.
942 WORD iconmask = 0xffff; // Icon mask.
943 LLINK animation = 0; // Animation.
945 // EAknNoteFlagWithSkinnableGraphics is used to distinguish AVKON_NOTE_SKINNED
946 // from AVKON_NOTE. Therefore it must always be set when using AVKON_NOTE_SKINNED.
947 // Other flags may also be set, and they have the same behaviour as AVKON_NOTE.
948 WORD flags = EAknNoteFlagWithSkinnableGraphics;
950 LLINK image_majorskinid = -1; // Major skin id for image, see AknsConstants.h.
951 LLINK image_minorskinid = -1; // Minor skin id for image, see AknsConstants.h.
954 // ---------------------------------------------------------------------------
955 // AVKON_INDICATOR_POPUP_ITEM
956 // Resource structure for universal indicator pane items.
958 // ---------------------------------------------------------------------------
960 STRUCT AVKON_INDICATOR_POPUP_ITEM
962 // UID of the status indicator.
965 // Default text to be displayed for the indicator in the
966 // universal indicator popup.
969 // Reserved for future extensions.
973 // ---------------------------------------------------------------------------
974 // Sct navi BUTTONS resources:
975 // define the category button(s)
976 // ---------------------------------------------------------------------------
978 STRUCT AVKON_SCT_NAVI_BUTTONS
980 STRUCT navi_buttons[];
983 // ---------------------------------------------------------------------------
984 // Sct navi BUTTON resources
985 // define a category button
986 // ---------------------------------------------------------------------------
988 STRUCT AVKON_SCT_NAVI_BUTTON