xref: /trunk/main/officecfg/registry/schema/org/openoffice/Office/UI/Sidebar.xcs (revision d74d90d67faf993dbc903d3700a720956ac94b63)
1<?xml version="1.0" encoding="UTF-8"?>
2<!--***********************************************************
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements.  See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership.  The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License.  You may obtain a copy of the License at
11 *
12 *   http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied.  See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 *
21 ***********************************************************-->
22
23
24<!DOCTYPE oor:component-schema SYSTEM "../../../../../component-schema.dtd">
25<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="Sidebar" oor:package="org.openoffice.Office.UI" xml:lang="en-US">
26  <info>
27    <author>Andre Fischer</author>
28    <desc>Specification of decks and content panels of the sidebar.</desc>
29  </info>
30  <templates>
31    <group oor:name="Deck">
32      <info>
33        <desc>Specification of a sidebar deck which is a container of content panels.</desc>
34      </info>
35      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
36        <info>
37          <desc>The deck title is displayed above the content panels.</desc>
38        </info>
39        <value></value>
40      </prop>
41      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
42        <info>
43          <desc>Internally used to identify the deck.  Not displayed in the UI.</desc>
44        </info>
45        <value></value>
46      </prop>
47      <prop oor:name="IconURL" oor:type="xs:string">
48        <info>
49          <desc>This icon is displayed in the sidebar tab bar.
50          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
51        </info>
52        <value></value>
53      </prop>
54      <prop oor:name="HighContrastIconURL" oor:type="xs:string">
55        <info>
56          <desc>This icon is displayed in the sidebar tab bar when high contrast mode is active.
57          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
58        </info>
59        <value></value>
60      </prop>
61      <prop oor:name="TitleBarIconURL" oor:type="xs:string">
62        <info>
63          <desc>This icon is displayed in the title bar of the deck.
64          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
65        </info>
66        <value></value>
67      </prop>
68      <prop oor:name="HighContrastTitleBarIconURL" oor:type="xs:string">
69        <info>
70          <desc>This icon is displayed in the title bar of the deck when high contrast mode is active.
71          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
72        </info>
73        <value></value>
74      </prop>
75      <prop oor:name="HelpURL" oor:type="xs:string">
76        <info>
77          <desc>Help about the sidebar deck.</desc>
78        </info>
79        <value></value>
80      </prop>
81      <prop oor:name="ContextList" oor:type="oor:string-list">
82        <info><desc>
83          List of context descriptors.  Each context descriptor is a string that contains four comma
84          separated values (note that values are case sensitive):
85          1  Application name. Valid values are
86                 com.sun.star.text.TextDocument
87                 com.sun.star.text.GlobalDocument
88                 com.sun.star.text.WebDocument
89                 com.sun.star.xforms.XMLFormDocument
90                 com.sun.star.sheet.SpreadsheetDocument
91                 com.sun.star.presentation.PresentationDocument
92                 com.sun.star.drawing.DrawingDocument
93
94             Recognized shortcuts:
95                 Writer
96                 Calc
97                 Impress
98                 Draw
99
100             Shortcuts for multiple applications:
101                 DrawImpress
102                 WriterVariants
103             These shortcuts exist for even more convenience and handle the frequent case of Draw
104         and Impress as well as different variants of the Writer where they have otherwise
105         identical context descriptions.
106
107             Special values:
108                 any
109                 none
110
111          2  Context name
112              Know context names are 3DObject, Annotation, Auditing, Cell, Chart, Draw, DrawPage, DrawText,
113              EditCell, Form, Frame, Graphic, HandoutPage, MasterPage, Media, Multiobj, OLE, OutlineText,
114              Pivot, SlidesorterPage, Table, Text, TextObject,
115              default
116
117             Special values:
118                 any
119
120          3  Panel state.  One of
121             visible  Panel is initially visible and expanded
122             hidden   Panel is initially collapsed, ie only its title bar is visible
123
124          4  (Optional, only used for panels) UNO command that overrides the DefaultMenuCommand.  Use
125             the special value none to override the DefaultMenuCommand to the empty string and thereby
126             disable the showing of a) the menu button in the panel titlebar and b) the showing of a dialog.
127        </desc></info>
128      </prop>
129      <prop oor:name="OrderIndex" oor:type="xs:int">
130        <info>
131          <desc>Index used for ordering decks in the tab bar.  Smaller values correspond to positions nearer to the top of the tab bar.</desc>
132        </info>
133        <value>10000</value>
134      </prop>
135    </group>
136    <group oor:name="Panel">
137      <info>
138        <desc>Specification of a sidebar content panel.</desc>
139      </info>
140      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
141        <info>
142          <desc>The panel title is displayed above the content panel.</desc>
143        </info>
144        <value></value>
145      </prop>
146      <prop oor:name="TitleBarIsOptional" oor:type="xs:boolean">
147        <info>
148          <desc>When true then the title bar can be ommitted when the panel is the only panel in a deck.</desc>
149        </info>
150        <value>false</value>
151      </prop>
152      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
153        <info>
154          <desc>Internally used to identify the panel.</desc>
155        </info>
156        <value></value>
157      </prop>
158      <prop oor:name="DeckId" oor:type="xs:string" oor:localized="false">
159        <info>
160          <desc>Id of the deck to which the panel belongs.</desc>
161        </info>
162        <value></value>
163      </prop>
164      <prop oor:name="TitleBarIconURL" oor:type="xs:string">
165        <info>
166          <desc>This icon is displayed in the title bar of the panel.
167          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
168        </info>
169        <value></value>
170      </prop>
171      <prop oor:name="HighContrastTitleBarIconURL" oor:type="xs:string">
172        <info>
173          <desc>This icon is displayed in the title bar of the panel when high contrast mode is active.
174          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
175        </info>
176        <value></value>
177      </prop>
178      <prop oor:name="HelpURL" oor:type="xs:string">
179        <info>
180          <desc>Help about the sidebar content panel.</desc>
181        </info>
182        <value></value>
183      </prop>
184      <prop oor:name="DefaultMenuCommand" oor:type="xs:string">
185        <info><desc>
186          The default UNO command to execute when the user clicks on the menu button in the panel title bar.
187          Can be overriden in the ContextList to provide context dependent menu dialogs.
188          When empty then the menu icon is not shown in the panel title bar.
189        </desc></info>
190        <value></value>
191      </prop>
192      <prop oor:name="ContextList" oor:type="oor:string-list">
193        <info>
194          <desc>For documentation, please see the Deck/ContextList.</desc>
195        </info>
196      </prop>
197      <prop oor:name="ImplementationURL" oor:type="xs:string">
198        <info>
199          <desc>URL by which the implementation of the panel is known by its factory.</desc>
200        </info>
201        <value></value>
202      </prop>
203      <prop oor:name="OrderIndex" oor:type="xs:int">
204        <info>
205          <desc>Index used for ordering panels inside a deck.  Smaller values correspond to positions nearer to the top of the deck.</desc>
206        </info>
207        <value>10000</value>
208      </prop>
209      <prop oor:name="WantsCanvas" oor:type="xs:boolean">
210        <info>
211          <desc>Experimental: Set to true when panel wants to paint its content via a XCanvas.</desc>
212        </info>
213        <value>false</value>
214      </prop>
215    </group>
216  </templates>
217  <component>
218    <group oor:name="Content">
219      <info>
220        <desc>Description of the decks and panels that can be displayed in the content area of the sidebar.</desc>
221      </info>
222      <set oor:name="DeckList" oor:node-type="Deck">
223        <info>
224          <desc>Contains all registered sidebar decks.</desc>
225        </info>
226      </set>
227      <set oor:name="PanelList" oor:node-type="Panel">
228        <info>
229          <desc>Contains all registered sidebar content panels.</desc>
230        </info>
231      </set>
232    </group>
233  </component>
234</oor:component-schema>
235