home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 June / maximum-cd-2009-06.iso / DiscContents / OOo_3.0.1_Win32Intel_install_wJRE_en-US.exe / openofficeorg1.cab / OptionsDialog.xcs < prev    next >
Encoding:
Extensible Markup Language  |  2008-12-15  |  10.5 KB  |  256 lines
  1. <?xml version="1.0"?>
  2. <oor:component-schema xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" oor:name="OptionsDialog" oor:package="org.openoffice.Office" xml:lang="en-US">
  3.   <info>
  4.     <desc>Contains general structures used to hide a single option or an option 
  5.       tabpage or a whole option group.</desc>
  6.   </info>
  7.   <templates>
  8.     <group oor:name="SingleOption">
  9.       <info>
  10.         <desc>Describes one single option.</desc>
  11.       </info>
  12.       <prop oor:name="Hide" oor:type="xs:boolean">
  13.         <info>
  14.           <desc>Should this option be hidden?.</desc>
  15.         </info>
  16.       </prop>
  17.     </group>
  18.     <group oor:name="OptionsPage">
  19.       <info>
  20.         <desc>Describes one options tabpage.</desc>
  21.       </info>
  22.       <prop oor:name="Hide" oor:type="xs:boolean">
  23.         <info>
  24.           <desc>Should this page be hidden?</desc>
  25.         </info>
  26.       </prop>
  27.       <set oor:name="Options" oor:node-type="SingleOption">
  28.         <info>
  29.           <desc>An optional set to allow to hide single options of this page.</desc>
  30.         </info>
  31.       </set>
  32.     </group>
  33.     <group oor:name="OptionsGroup">
  34.       <info>
  35.         <desc>Describes a group of options tabpages.</desc>
  36.       </info>
  37.       <prop oor:name="Hide" oor:type="xs:boolean">
  38.         <info>
  39.           <desc>Should this whole group of options tabpages be hidden?</desc>
  40.         </info>
  41.       </prop>
  42.       <set oor:name="Pages" oor:node-type="OptionsPage">
  43.         <info>
  44.           <desc>An optional set to allow to hide single options tabpages of this 
  45.         group.</desc>
  46.         </info>
  47.       </set>
  48.     </group>
  49.     <group oor:name="Module">
  50.       <info>
  51.         <desc>Defines a Module. The options dialog displays entries in its tree
  52.       view only if they are defined to belong to the Module for which the 
  53.       options dialog is being displayed. The exception is the options dialog 
  54.       which is invoked from the Extension Manager, where the Module is 
  55.       irrelevant.</desc>
  56.       </info>
  57.       <set oor:name="Nodes" oor:node-type="OrderedNode">
  58.         <info>
  59.           <desc>A set member countains a Node (see type Node) which has been 
  60.         assigned to this Module. Also entities which do not own the Module 
  61.         may add members to the set. Please look at the specification for 
  62.         applying restrictions
  63.         (http://specs.openoffice.org/appwide/packagemanager/options_dialog_for_extensions.odt)
  64.         The actual Node|s are kept in a separate set (OptionsDialog/Nodes),
  65.         to prevent redundancy, because a Node can be assigned to several 
  66.         Module|s. The position of a node (the tree view element) within the 
  67.         tree view of the options dialog is determined by the property Index 
  68.         of each set member. The position can be different dependent on the 
  69.         Module. Therefore the order is determined per Module. Only the owner 
  70.         of the Module should set the position (property Index).
  71.         The order is undefined if two or more members have the same value for 
  72.         the Index property.
  73.         See also the description for OrderedNode.
  74.       </desc>
  75.         </info>
  76.       </set>
  77.     </group>
  78.     <group oor:name="Node">
  79.       <info>
  80.         <desc>Defines a node (the tree view element) which can be displayed in 
  81.       the tree view of the options dialog.</desc>
  82.       </info>
  83.       <prop oor:name="Label" oor:type="xs:string" oor:localized="true" oor:nillable="false">
  84.         <info>
  85.           <desc>The localized name which is displayed next to the node in the 
  86.         options dialog. If two different nodes (the tree view element) happen 
  87.         to have the same localized name then both are displayed.</desc>
  88.         </info>
  89.       </prop>
  90.       <prop oor:name="OptionsPage" oor:type="xs:string">
  91.         <info>
  92.           <desc>URL which references the dialog editor resource. This options 
  93.       page should only contain information for the user and should not 
  94.       accept input.</desc>
  95.         </info>
  96.       </prop>
  97.       <prop oor:name="AllModules" oor:type="xs:boolean">
  98.         <info>
  99.           <desc>If true then this Node shall be displayed independent of the 
  100.         Module for which the options dialog is displayed -  that is, always. 
  101.         In this case it must not be assigned directly to one ore more 
  102.         Module|s. That is, it must not exist as member in Module/Nodes of no
  103.         existing Module. 
  104.         This is an optimization so that an extension need not provide 
  105.         entries for all Module|s. 
  106.         The default value is false.
  107.       </desc>
  108.         </info>
  109.         <value>false</value>
  110.       </prop>
  111.       <prop oor:name="GroupId" oor:type="xs:string">
  112.         <info>
  113.           <desc>Identifies a group of Node|s. All nodes (the tree view elements) 
  114.         which refer to the same group are displayed next to each other. If 
  115.         this property is set then GroupIndex must also have a value. The 
  116.         group will be used by Node|s which have been added to existing 
  117.         Module|s. If one defines a Module AND Node|s which are used in this 
  118.         Module, then GroupId must not be set. In this case one uses 
  119.         Module/Nodes/Index to determine the position of the nodes (the tree 
  120.         view element).
  121.         The empty string is no valid identifier and represents nil.
  122.         See also GroupIndex.
  123.       </desc>
  124.         </info>
  125.         <value/>
  126.       </prop>
  127.       <prop oor:name="GroupIndex" oor:type="xs:int">
  128.         <info>
  129.           <desc>The index of the Node within the group. The index starts with 
  130.         null. If this property is set then property GroupId must also have 
  131.         a value. If a Node of this group is displayed depends on the 
  132.         respective Module to which it is assigned. For example, if there are 
  133.         the Nodes A(index 0), B (index 1), and C (index 2) in a group, 
  134.         and B is assigned to a different Module, then only A and 
  135.         B are displayed together although there indices are 0 and 2 (B has 1).
  136.         The value -1 is regarded as nil.
  137.         Actually one could have allowed to define a group per Module, so that 
  138.         the order could be different depending on the Module. But this would 
  139.         have added more complexity to the data structures.
  140.       </desc>
  141.         </info>
  142.         <value>-1</value>
  143.       </prop>
  144.       <set oor:name="Leaves" oor:node-type="Leaf">
  145.         <info>
  146.           <desc>Leaves which are assigned to this node. Extensions can add to this 
  147.         set new Leaf|s.</desc>
  148.         </info>
  149.       </set>
  150.     </group>
  151.     <group oor:name="Leaf">
  152.       <info>
  153.         <desc>Defines a leaf (the tree view element). A Leaf must be assigned to 
  154.       exactly one Node. </desc>
  155.       </info>
  156.       <prop oor:name="Id" oor:type="xs:string">
  157.         <info>
  158.           <desc>The unique identifier of the Leaf. This must be the extension 
  159.         identifier if this Leaf was defined by an extension.</desc>
  160.         </info>
  161.       </prop>
  162.       <prop oor:name="Label" oor:type="xs:string" oor:localized="true" oor:nillable="false">
  163.         <info>
  164.           <desc>The localized name that is displayed for the leaf in the options 
  165.         dialog.</desc>
  166.         </info>
  167.       </prop>
  168.       <prop oor:name="OptionsPage" oor:type="xs:string" oor:nillable="false">
  169.         <info>
  170.           <desc>A URL which references the window resource.</desc>
  171.         </info>
  172.       </prop>
  173.       <prop oor:name="EventHandlerService" oor:type="xs:string" oor:nillable="false">
  174.         <info>
  175.           <desc>Name of the event handler service which is used as argument in 
  176.         com.sun.star.awt.XContainerWindowProvider.createContainerWindow. This 
  177.         handler does not even process events from the options page but also 
  178.         provides for saving and reading the respective values.</desc>
  179.         </info>
  180.       </prop>
  181.       <prop oor:name="GroupId" oor:type="xs:string">
  182.         <info>
  183.           <desc>Identifies a group of Leaf|s. All Leaf|s which have the same 
  184.         GroupId form a group and the corresponding entries in the tree view
  185.         are displayed next to each other.
  186.         If this property is set then the property GroupIndex must
  187.         also be set.
  188.         The GroupIndex represents the position within the group. If one 
  189.         owns the Node (e.g. defined it oneself) then one can set the GroupId 
  190.         to the name of the Node to which this Leaf is assigned. The Leaf|s of 
  191.         this particular group are displayed first under the node (the tree 
  192.         view element) before any other groups.
  193.         If one does not own the Node then one should not use the Node name as 
  194.         group id.
  195.         The empty string is regarded as nil.
  196.       </desc>
  197.         </info>
  198.         <value/>
  199.       </prop>
  200.       <prop oor:name="GroupIndex" oor:type="xs:int">
  201.         <info>
  202.           <desc>The index of the Leaf within the group. The index starts with 
  203.         null. If this property is set then GroupId must also have 
  204.         a value. If there are two Leaf|s with the same index in the same 
  205.         group then then their order is undefined.
  206.         The value -1 is regarded as nil.</desc>
  207.         </info>
  208.         <value>-1</value>
  209.       </prop>
  210.     </group>
  211.     <group oor:name="OrderedNode">
  212.       <info>
  213.         <desc>Represents a reference to a Node and an optional index. 
  214.       Instances of this type are used in a set (see Module). The name of the 
  215.       set member must be the same as the one of the respective Node. The 
  216.       index determines the position of the node (the tree view element) in 
  217.       the options dialog for a particular Module.</desc>
  218.       </info>
  219.       <prop oor:name="Index" oor:type="xs:int">
  220.         <info>
  221.           <desc>Determines the position of the node in the options dialog. 
  222.         The index starts with null. That is, the corresponding node 
  223.         appears at the first position in the tree view of the options dialog.
  224.         If the value is -1 then the index is undefined. If one adds
  225.         Node|s to a Module which one does not define oneself (e.g. the Module
  226.         is owned by someone else), then one must not set the Index. This 
  227.         applies, for example, to extensions which add their Node|s to existing 
  228.         Module|s.
  229.         The value -1 is regarded as nil.
  230.       </desc>
  231.         </info>
  232.         <value>-1</value>
  233.       </prop>
  234.     </group>
  235.   </templates>
  236.   <component>
  237.     <set oor:name="OptionsDialogGroups" oor:node-type="OptionsGroup">
  238.       <info>
  239.         <desc>Contains the set of single options, options tabpages and options 
  240.       groups which should be hidden.</desc>
  241.         <label>Hidden options</label>
  242.       </info>
  243.     </set>
  244.     <set oor:name="Modules" oor:node-type="Module">
  245.       <info>
  246.         <desc>List of availabe application contexts</desc>
  247.       </info>
  248.     </set>
  249.     <set oor:name="Nodes" oor:node-type="Node">
  250.       <info>
  251.         <desc>List of available nodes.</desc>
  252.       </info>
  253.     </set>
  254.   </component>
  255. </oor:component-schema>
  256.