diff -r 000000000000 -r f72a12da539e menufw/menusuites/data/mmenuschema.xsd --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/menufw/menusuites/data/mmenuschema.xsd Thu Dec 17 08:40:49 2009 +0200 @@ -0,0 +1,592 @@ + + + + + This Tag is the root element of configuration and defines namespaces for XML needs + + + + + + Localization tag should be used in order to map resource sources to namespaces. It enables use of resources in context of namespaces. Namespace are not only limited to single xml file – they have global scope, and once defined, are available in all definition files. + + + + + This tag defines single suite + + + + + + + + + This tag defines suite’s single or multiple items. It contains information about graphical representation, menu structure, actions, and queries. + + + + + + + + + + + + + + + This defines the suite name, for which the contents of the tag should relate to. It should be specified, for xml files containing items for a suite. Xml configuration files for suites do not require this, since they define the suite. + + + + + + + + Menu item may contain nested menu items. + + + + A nested menu item. + + + + + + Localized name of the menu item, which will be displayed in the menu. + + + + + Position in the menu (used to control the order in which the items are displayed). Predefined menu items have their position defined at 100, 200 etc, so it is easy to position custom menu items between the predefined ones. + + + + + Event related with the item. Mapped to specific action in mmenu:event section. Parameter should start with custom:” string followed with event name to indicate creation of a new event related to menu item and not to a predefined event. For list of predefined event see event Tag description (3.7) + + + + + + + + Defines a key structure. A key, may contain nested keys. Keys are store information. + + + + + + + + + + + + + name of the parameter + + + + + + + + + + type of the parameter Values: +- string +- string16 +- formatted_string +- integer +- uid +- boolean + + + + + + + + + + + + + + + + + + value of the parameter + + + + + + Describes the logicla template to be used for widget's presentation. Logical templates are specific for widgets, so configuration should be consulted with documentation. If suite allows multiple widget types, multiple tempaltes may be specified using the "|" character. + + + + + + + + Desribes the type of a widget. If a suite allows multiple widgets, the values should be separated by "|" character. + + + + + + + + Type defines the structure to access liw services. + + + + + Element defines the parameters needed to fetch the service interface. In this section service specific parameters may be defined. The section should contain a series of mmenu:key elements + + + + + Defines command name (to be invoked on the interface) and invocation method (synchronous or asynchronous) + + + + + + This tak contains xml structured data (mmenu:key) as it will be passed to the service + + + + + + name of the command to invoke on the interface + + + + + + + + + + mode definition. Either “sync” for synchronous invocation or “async” +asynchronous invocation + + + + + + + + + + + + + + + name of the service producing output: e.g. “Service.TestMatrixDataService”. + + + + + + + + + + interface used for the query: e.g. “ITestMatrixDataSource”. + + + + + + Type defines the configuration of a specific event handling. + + + + + + + + + + + + + + + + + + + + + Type defines the configuration of an image. + + + + + + + + + + + + + + + + + + + + + + + + + Type defines the configuration of text value. + + + + + + + + + + + + + + This type defines the configuration of a toolbar. + + + + + + + + + + + + + + + This type defines the configuration of a button in a toolbar. + + + + + + + + + + + + + + + + + + Event related with the item. Mapped to specific action in mmenu:event section. Parameter should start with custom:” string followed with event name to indicate creation of a new event related to menu item and not to a predefined event. For list of predefined event see event Tag description (3.7) + + + + + + + This type defines the configuration of an item. + + + + + + The tag is used to describe user menu appearance when item is focused, and which events will occur when menu item is selected. + + + + + This tag is the same as menuitem but describes menu items displayed only which have specific relation to the item + + + + + This element describes the layout of toolbar, for the highlighted item. + + + + + Defines parameters used to construct queries to services and display dynamically modifiable data. + + + + + + + + + + + + Registers for notifications in a liw service. + + + + + + Configures layout of graphical items. + + + + + + + + + Defines UI graphical element to which content will be linked to. Some UI elements: +- mul_name is the main item shown in graphical list item, +- mul_detail represents secondary line, +- mul_icon is the icon for the list item. + +The complete definition of all aliases can be obtained from [3]. Aliases are dependant of the presentation type, thus one should be well acquainted with [3] to achieve expected result. + + + + + + + + + + + + + + + + + + + + + + + Content type. Values: +- string +- string16 +- formatted_string +- integer +- uid +- boolean + +Use “string” type for icons and constant texts and “formatted_string” type for texts with parameters + + + + + + + + + + + + + + + + + Hard coded value for the parameter or a reference. + + + + + + + + Used to specify event handling, for predefined and custom events. + + + + + + + + + Logical template which will be used to represent data. The attribute is optional. When not specified a default value from suite definition is used. For more details see 2.3 + + + + + Number of items current section refers to. If all the available elements are to be retrieved a “*” sing should be used to indicate quantity + + + + + Type of an item (MCS). + + + + + Unique id of the item in the scope of the suite. + + + + + Information if item can be to move to other position + + + + + Information if item is currently running + + + + + Item's custom id, can be set using a value from liw variant or simple number. + + + + + Item's uid, can be set using a value from liw variant or simple uid. + + + + + + + + This type defines the configuration of a suite + + + + + + Defines parameters used to construct queries to services and display dynamically modifiable data. + + + + + + + + + + + + Used to specify event handling, for predefined and custom events. + + + + + + + Unique string identification of a suite + + + + + + + + Ttype of presentation. Available types are: +- grid +- list +- coverflow + +If a suite allows multiple types, they should be separated with "|" character. + + + + + + + + + Logical template to specify the layout of a specific presentation type. +This parameter is strictly dependant on the values defined in [3]. One should be aware that although values of logical template may seem similar for different presentation types, they are different in their specification and count. Usually they are in form logical_template_x, where x is a number. For more details please consult [3]. + + + + + + Suite title, should contain localized value + + + + + + + Suite's custom id, can be set using a value from liw variant or simple number. + + + + + + + identifier used to access the resource + + + + + binary file with resources. File extension should be: +- RSC file for logical names, +- MBM for images and +- MIF for icons. + + + + + + + + + + + + + + + + Group of attributes, used to configure image from resource from liw bitmap buffer. + + + + + + + Group of attributes, used to configure text from resource. + + + + + + + Group of attributes, used to configure image from resource and/or skin. + + + + + + + + + + + If condition is fulfilled the menu is added to the item. May contain query reference which will be checked against specified condition. More about condition definition in mmenu:action section. + + + + + \ No newline at end of file