/*

* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* 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

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Resource structure definitions for Avkon.

*

*/

#ifndef __AVKON_HRH__

#include <avkon.hrh>

#endif

#if !defined(__BADEF_RH__)

#include <BADEF.RH>

#endif

#if !defined(__UIKON_HRH__)

#include <uikon.hrh>

#endif

STRUCT AVKON_SYSTEM_FONT

    {

    LONG fontuid; // a value from fontids.hrh

    STRUCT named_font; // this must be a NAMED_FONT structure type

    }

STRUCT NAVI_DECORATOR

    {

    WORD type=ENaviDecoratorControlNone;

    STRUCT control;

    }

STRUCT TITLE_PANE

    {

    LTEXT txt="";

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    }

STRUCT CONTEXT_PANE

    {

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    }

STRUCT TAB_GROUP

    {

    WORD tab_width = EAknTabWidthWithTwoTabs;  // two tabs

    WORD active = 0; // index of the first active tab

    STRUCT tabs[];

    }

STRUCT TAB

    {

    WORD id=0;

    LTEXT txt="";

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    }

STRUCT NAVI_LABEL

    {

    LTEXT txt="";

    }

STRUCT NAVI_IMAGE

    {

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    }

STRUCT SIGNAL_PANE

    {

    WORD level = 0;

    }

STRUCT BATTERY_PANE

    {

    WORD level = 0;

    }

STRUCT INDICATOR_PANE

    {

    STRUCT indicators[];

    }

STRUCT INDICATOR

    {

    WORD uid;

    WORD npriority=0xffff;

    WORD wpriority=0xffff;

    LTEXT bmpfile="";

    STRUCT states[];

    }

STRUCT INDICATOR_STATE

    {

    WORD id;

    STRUCT icons[];

    }

STRUCT INDICATOR_ICON

    {

    WORD narrowbmpid=0xffff;

    WORD narrowbmpmask=0xffff;

    WORD widebmpid=0xffff;

    WORD widebmpmask=0xffff;

    }

STRUCT AVKON_VIEW

    {

    BYTE version=0; // resource struct version, do not change.

    LLINK hotkeys=0;

    LLINK menubar=0;

    LLINK cba=0;

    LLINK toolbar=0;

    LLINK extension=0; // reserved for future extensions

    }

STRUCT AVKON_NOTE

    {

    WORD layout;

    LTEXT singular_label;

    LTEXT plural_label="";

    LTEXT imagefile="";

    WORD imageid=0xffff;

    WORD imagemask=0xffff;

    LTEXT iconfile="";

    WORD iconid=0xffff;

    WORD iconmask=0xffff;

    LLINK animation=0;

    WORD flags=0; //TNoteFlags (defined in aknnoteattributes.h)

    }

STRUCT NOTE_COMPONENT

    {

    WORD component_type;

    WORD x;

    WORD y;

    WORD width;

    WORD height;

    }

STRUCT NOTE

    {

    STRUCT components[];

    }

STRUCT AVKON_CONFIRMATION_QUERY

    {

    WORD layout;

    LTEXT label;

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    LLINK animation=0; 

    }

STRUCT AVKON_DATA_QUERY

    {

    WORD layout;

    LTEXT label;

    STRUCT control;

    }

STRUCT AVKON_MESSAGE_QUERY

    {

    LTEXT message = "";

    }

STRUCT AVKON_MULTI_LINE_DATA_QUERY

    {

    WORD layout;   

    LTEXT firstlabel;

    LLINK firstcontrol;

    LTEXT secondlabel;

    LLINK secondcontrol;

    }

// use this with CAknQueryDialog.

// This is for one dialog DLG line with EAknCtListQueryControl

//

// The list query window type is determined from EAknCtSinglePopupMenuListBox - if you want to

// have your own borders, derive from CAknListQueryDialog and override some methods.

STRUCT AVKON_LIST_QUERY_CONTROL

    {

    WORD listtype; // type of the list, for example EAknCtSinglePopupMenuListBox (window type is determined from this)

    STRUCT listbox; // LISTBOX resource, use AVKON_LIST_QUERY_LIST or AVKON_MULTISELECTION_LIST_QUERY_LIST

    LTEXT heading = "";

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    LLINK animation=0;

    }

STRUCT AVKON_HEADING

    {

    LTEXT label = "";  // default is no heading

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    LLINK animation=0;

    LLINK headinglayout = R_AVKON_LIST_HEADING_PANE;

    }

// CAknPopupField

STRUCT POPUP_FIELD

    {

    WORD flags=0; // permitted flags: EAknPopupFieldFlagAllowsUserDefinedEntry

    WORD width=0; // in characters

    LTEXT other=""; // if non-empty, replaces 

    LLINK emptynote = 0; // note to be displayed if popupfield is empty

    LTEXT empty=""; // text to display if popupfield is empty

    LTEXT invalid = ""; // text to display if popupfield is invalid

    }

STRUCT POPUP_FIELD_TEXT

    {

    STRUCT popupfield; // only use POPUP_FIELD here

    LLINK textarray = 0; // resource ID of an array of text

    WORD active = 0; // zero based, item in textarray to be initially selected

    }

STRUCT POPUP_FIELD_SELECTION_BMP

    {

    LTEXT bmpfile="";

    WORD bmpidon=0xffff;

    WORD bmpmaskon=0xffff;

    WORD bmpidoff=0xffff;

    WORD bmpmaskoff=0xffff;

    }

STRUCT SLIDER

    {

    WORD layout;

    WORD minvalue;

    WORD maxvalue;

    WORD step;

    WORD valuetype=EAknSliderValueBareFigure;

    WORD decimalplaces=0;

    LTEXT singular_valuelabel = "";

    LTEXT minlabel="";

    LTEXT maxlabel="";

    LTEXT valuelabel="";

    LLINK graphical_image=0;

    }

/** used with CAknVolumeControl

 * see avkon.hrh for the flag definitions

 * This struct uses default values for volume range:

 *  ESettingsVolumeControl, EDynRangeSettingsVolumeControl: 1-10

 *  ENaviPaneVolumeControl, EPopupVolumeControl, EDynRangeNaviPaneVolumeControl, 

 *  EDynRangePopupVolumeControl, ESmallPopupVolumeControl, 

 *  ESmallPopupVolumeControlWithPercent: 0-10   

 */ 

STRUCT VOLUME

    {

    WORD flags;

    WORD value;

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    }

/** used with CAknVolumeControl

 *  This struct is used with flags defined in

 *  TAknVolumeControlDynamicLayouts

 *  see avkon.hrh for the flag definitions

 *  @since 3.2 

 */ 

STRUCT DYNAMIC_VOLUME

    {

    WORD identifier = 0xffff;  // Do not change

    WORD flags;

    WORD value;

    LTEXT bmpfile="";

    WORD bmpid=0xffff;

    WORD bmpmask=0xffff;

    WORD minvalue = 0;

    WORD maxvalue = 10;

    }

STRUCT NUMSECRETED

    {

    WORD num_code_chars=8;

    }

STRUCT GRID_STYLE

    {

    WORD layoutflags = 0;

    WORD primaryscroll = 0;

    WORD secondaryscroll = 0;

    WORD itemsinprimaryorient = 0;

    WORD itemsinsecondaryorient = 0;

    WORD height = 0;

    WORD width = 0;

    WORD gapwidth = 0;

    WORD gapheight = 0;

    }

STRUCT GRID

    {

    BYTE version = 0;

    LONG flags = 0;

    WORD height = 5;        // in items

    WORD width = 10;        // in chars

    LLINK array_id = 0;

    LTEXT emptytext = "";

    LLINK style = 0; 

    }

STRUCT AVKON_SETTING_PAGE

    {

    WORD number = EAknSettingPageNoOrdinalDisplayed;

    LTEXT label;

    LTEXT hint_text;

    LLINK softkey_resource = 0;

    LLINK menubar= 0;

    WORD type=0xffff;

    LLINK editor_resource_id = 0;

    LLINK invalid_contents_softkey_resource = 0;

    LLINK extension = 0;

    }

STRUCT AVKON_SETTING_ITEM_LIST

    {

    WORD flags = 0; // Allowed values: EAknSettingItemListNumberedStyle 

    LTEXT title = "";

    WORD initial_number = 1;

    STRUCT items[];

    }

STRUCT AVKON_SETTING_ITEM

    {

    WORD identifier = 0;

    LTEXT name ="";

    LLINK setting_page_resource = 0;

    WORD type=0xffff;  

    LLINK setting_editor_resource = 0;

    LLINK associated_resource = 0;

    LTEXT empty_item_text = "";

    LTEXT compulsory_ind_string = "";

    LLINK reserved = 0;  // Added for extensions

    }

STRUCT AVKON_PASSWORD_CONFIRMATION

    {

    LLINK password_query_resource = 0;

    LLINK success_note_resource = 0;

    LLINK failure_note_resource = 0;

    }

STRUCT AVKON_ENUMERATED_TEXT

    {

    WORD value = 0 ;

    LTEXT text;

    }

STRUCT AVKON_POPUP_SETTING_TEXTS

    {

    WORD flags = 0;

    LLINK setting_texts_resource = 0;

    LLINK popped_up_texts_resource = 0;

    LLINK reserved = 0;

    }

STRUCT AVKON_SEARCH_FIELD

    {

    }

STRUCT AVKON_LISTBOX_LINES

    {

    STRUCT vline1;

    STRUCT vline2;

    STRUCT hline;

    }

// Bitmap Animation

STRUCT BMPANIM_DATA

    {

    BYTE identifier = 0; // Do not change, used to identify the used resource struct.

    WORD frameinterval  = -1;

    WORD playmode       = 0;

    BYTE flash      = 0;

    LTEXT bmpfile       = "";

    LLINK frames        = 0;

    LLINK backgroundframe   = 0;

    }

STRUCT BMPANIM_FRAME

    {

    WORD time       = -1;

    WORD posx       = 0;

    WORD posy       = 0;

    WORD bmpid      = -1;

    WORD maskid     = -1;

    }

// Resource-based layout resources (Deprecated)

// These does not define absolute coordinates => resizing these layouts is possible!

//

// (those which does not mention column or form in their name could be used later by

// other controls for their layout - there will be generic resource reader for these)

// this is used with listboxes

STRUCT AVKON_LB_LAYOUT_POS

    {

    WORD l=ELayoutEmpty; 

    WORD t=ELayoutEmpty; 

    WORD r=ELayoutEmpty; 

    WORD b=ELayoutEmpty; 

    WORD W=ELayoutEmpty; 

    WORD H=ELayoutEmpty;

    }

// this is used with listboxes too

STRUCT AVKON_LB_LAYOUT_GFX

    {

    WORD id;

    WORD C=ELayoutEmpty;

    WORD l=ELayoutEmpty;

    WORD t=ELayoutEmpty;

    WORD r=ELayoutEmpty;

    WORD b=ELayoutEmpty;

    WORD W=ELayoutEmpty;

    WORD H=ELayoutEmpty;

    }

// This is used with listboxes

STRUCT AVKON_LB_LAYOUT_TEXT

    {

    WORD id;

    WORD font; WORD C; WORD lm; WORD rm;  WORD B; WORD W; WORD align;

    }

// This is used with CAknLayoutUtils::LayoutControl()

STRUCT AVKON_LAYOUT_CONTROL

    {

    WORD C=ELayoutEmpty;

    WORD l=ELayoutEmpty;

    WORD t=ELayoutEmpty;

    WORD r=ELayoutEmpty;

    WORD b=ELayoutEmpty;

    WORD W=ELayoutEmpty;

    WORD H=ELayoutEmpty;

    }

// This is used with TAknLayoutRect

STRUCT AVKON_LAYOUT_RECT

    {

    WORD C=ELayoutEmpty;

    WORD l=ELayoutEmpty;

    WORD t=ELayoutEmpty;

    WORD r=ELayoutEmpty;

    WORD b=ELayoutEmpty;

    WORD W=ELayoutEmpty;

    WORD H=ELayoutEmpty;

    }

// this is used with AknListBoxLayouts::LayoutImage

#define AVKON_LAYOUT_IMAGE AVKON_LAYOUT_RECT

STRUCT AVKON_LAYOUT_TEXT

    {

    WORD font;

    WORD C;

    WORD l;

    WORD r;

    WORD B;

    WORD W;

    WORD J;

    }

// This should be used with CAknLayoutUtils::LayoutEdwin

STRUCT AVKON_LAYOUT_EDWIN

    {

    WORD font;

    WORD C;

    WORD l;