xref: /trunk/main/officecfg/registry/schema/org/openoffice/Office/UI/Sidebar.xcs (revision 0d4ba6f965e72ea5d32a4869e5572bd93ba7cae0)
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.sdb.FormDesign
91                 com.sun.star.sheet.SpreadsheetDocument
92                 com.sun.star.presentation.PresentationDocument
93                 com.sun.star.drawing.DrawingDocument
94
95             Recognized shortcuts:
96                 Writer
97                 Calc
98                 Impress
99                 Draw
100
101             Shortcuts for multiple applications:
102                 DrawImpress
103                 WriterVariants
104             These shortcuts exist for even more convenience and handle the frequent case of Draw
105         and Impress as well as different variants of the Writer where they have otherwise
106         identical context descriptions.
107
108             Special values:
109                 any
110                 none
111
112          2  Context name
113              Know context names are 3DObject, Annotation, Auditing, Cell, Chart, Draw, DrawPage, DrawText,
114              EditCell, Form, Frame, Graphic, HandoutPage, MasterPage, Media, Multiobj, OLE, OutlineText,
115              Pivot, SlidesorterPage, Table, Text, TextObject,
116              default
117
118             Special values:
119                 any
120
121          3  Panel state.  One of
122             visible  Panel is initially visible and expanded
123             hidden   Panel is initially collapsed, ie only its title bar is visible
124
125          4  (Optional, only used for panels) UNO command that overrides the DefaultMenuCommand.  Use
126             the special value none to override the DefaultMenuCommand to the empty string and thereby
127             disable the showing of a) the menu button in the panel titlebar and b) the showing of a dialog.
128        </desc></info>
129      </prop>
130      <prop oor:name="OrderIndex" oor:type="xs:int">
131        <info>
132          <desc>Index used for ordering decks in the tab bar.  Smaller values correspond to positions nearer to the top of the tab bar.</desc>
133        </info>
134        <value>10000</value>
135      </prop>
136    </group>
137    <group oor:name="Panel">
138      <info>
139        <desc>Specification of a sidebar content panel.</desc>
140      </info>
141      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
142        <info>
143          <desc>The panel title is displayed above the content panel.</desc>
144        </info>
145        <value></value>
146      </prop>
147      <prop oor:name="TitleBarIsOptional" oor:type="xs:boolean">
148        <info>
149          <desc>When true then the title bar can be ommitted when the panel is the only panel in a deck.</desc>
150        </info>
151        <value>false</value>
152      </prop>
153      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
154        <info>
155          <desc>Internally used to identify the panel.</desc>
156        </info>
157        <value></value>
158      </prop>
159      <prop oor:name="DeckId" oor:type="xs:string" oor:localized="false">
160        <info>
161          <desc>Id of the deck to which the panel belongs.</desc>
162        </info>
163        <value></value>
164      </prop>
165      <prop oor:name="TitleBarIconURL" oor:type="xs:string">
166        <info>
167          <desc>This icon is displayed in the title bar of the panel.
168          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
169        </info>
170        <value></value>
171      </prop>
172      <prop oor:name="HighContrastTitleBarIconURL" oor:type="xs:string">
173        <info>
174          <desc>This icon is displayed in the title bar of the panel when high contrast mode is active.
175          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
176        </info>
177        <value></value>
178      </prop>
179      <prop oor:name="HelpURL" oor:type="xs:string">
180        <info>
181          <desc>Help about the sidebar content panel.</desc>
182        </info>
183        <value></value>
184      </prop>
185      <prop oor:name="DefaultMenuCommand" oor:type="xs:string">
186        <info><desc>
187          The default UNO command to execute when the user clicks on the menu button in the panel title bar.
188          Can be overriden in the ContextList to provide context dependent menu dialogs.
189          When empty then the menu icon is not shown in the panel title bar.
190        </desc></info>
191        <value></value>
192      </prop>
193      <prop oor:name="ContextList" oor:type="oor:string-list">
194        <info>
195          <desc>For documentation, please see the Deck/ContextList.</desc>
196        </info>
197      </prop>
198      <prop oor:name="ImplementationURL" oor:type="xs:string">
199        <info>
200          <desc>URL by which the implementation of the panel is known by its factory.</desc>
201        </info>
202        <value></value>
203      </prop>
204      <prop oor:name="OrderIndex" oor:type="xs:int">
205        <info>
206          <desc>Index used for ordering panels inside a deck.  Smaller values correspond to positions nearer to the top of the deck.</desc>
207        </info>
208        <value>10000</value>
209      </prop>
210      <prop oor:name="ShowForReadOnlyDocument" oor:type="xs:boolean">
211        <info>
212          <desc>This flag controls whether the panel is shown when the document in the edit view is read only.</desc>
213        </info>
214        <value>false</value>
215      </prop>
216      <prop oor:name="WantsCanvas" oor:type="xs:boolean">
217        <info>
218          <desc>Experimental: Set to true when panel wants to paint its content via a XCanvas.</desc>
219        </info>
220        <value>false</value>
221      </prop>
222    </group>
223  </templates>
224  <component>
225    <group oor:name="Content">
226      <info>
227        <desc>Description of the decks and panels that can be displayed in the content area of the sidebar.</desc>
228      </info>
229      <set oor:name="DeckList" oor:node-type="Deck">
230        <info>
231          <desc>Contains all registered sidebar decks.</desc>
232        </info>
233      </set>
234      <set oor:name="PanelList" oor:node-type="Panel">
235        <info>
236          <desc>Contains all registered sidebar content panels.</desc>
237        </info>
238      </set>
239    </group>
240  </component>
241</oor:component-schema>
242