summaryrefslogtreecommitdiff
path: root/officecfg/registry/schema/org/openoffice/Office/UI/Sidebar.xcs
blob: c54c3d6076c0b619ed54b2012c4132c47e2f5ebd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 -->
<!DOCTYPE oor:component-schema SYSTEM "../../../../../component-schema.dtd">
<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">
  <info>
    <desc>Specification of decks and content panels of the sidebar.</desc>
  </info>
  <templates>
    <group oor:name="Deck">
      <info>
        <desc>Specification of a sidebar deck which is a container of content panels.</desc>
      </info>
      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
        <info>
          <desc>The deck title is displayed above the content panels.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
        <info>
          <desc>Internally used to identify the deck.  Not displayed in the UI.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="IconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the sidebar tab bar.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="HighContrastIconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the sidebar tab bar when high contrast mode is active.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="TitleBarIconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the title bar of the deck.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="HighContrastTitleBarIconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the title bar of the deck when high contrast mode is active.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="HelpURL" oor:type="xs:string">
        <info>
          <desc>Help about the sidebar deck.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="ContextList" oor:type="oor:string-list">
        <info><desc>
          List of context descriptors.  Each context descriptor is a string that contains four comma
          separated values (note that values are case sensitive):
          1  Application name. Valid values are
                 com.sun.star.text.TextDocument
                 com.sun.star.text.GlobalDocument
                 com.sun.star.text.WebDocument
                 com.sun.star.xforms.XMLFormDocument
                 com.sun.star.sdb.FormDesign
                 com.sun.star.sdb.TextReportDesign
                 com.sun.star.sheet.SpreadsheetDocument
                 com.sun.star.presentation.PresentationDocument
                 com.sun.star.drawing.DrawingDocument
                 com.sun.star.chart2.ChartDocument

             Recognized shortcuts:
                 Writer
                 Calc
                 Impress
                 Draw
                 Chart

             Shortcuts for multiple applications:
                 DrawImpress
                 WriterVariants
             These shortcuts exist for even more convenience and handle the frequent case of Draw
             and Impress as well as different variants of the Writer where they have otherwise
             identical context descriptions.

             Special values:
                 any
                 none

          2  Context name
              Know context names are 3DObject, Annotation, Auditing, Axis, Cell, Chart, Draw, DrawPage, DrawText,
              EditCell, ErrorBar, Form, Frame, Graphic, HandoutPage, MasterPage, Media, Multiobj, OLE, OutlineText,
              Pivot, Series, SlidesorterPage, Table, Text, TextObject, Trendline
              default

             Special values:
                 any

          3  Panel state.  One of
             visible  Panel is initially visible and expanded
             hidden   Panel is initially collapsed, ie only its title bar is visible

          4  (Optional, only used for panels) UNO command that overrides the DefaultMenuCommand.  Use
             the special value none to override the DefaultMenuCommand to the empty string and thereby
             disable the showing of a) the menu button in the panel titlebar and b) the showing of a dialog.
        </desc></info>
      </prop>
      <prop oor:name="OrderIndex" oor:type="xs:int">
        <info>
          <desc>Index used for ordering decks in the tab bar.  Smaller values correspond to positions nearer to the top of the tab bar.</desc>
        </info>
        <value>10000</value>
      </prop>
      <prop oor:name="IsExperimental" oor:type="xs:boolean">
        <info>
          <desc>This flag controls whether the deck is experimental and is shown only when experimental mode is enabled.</desc>
        </info>
        <value>false</value>
      </prop>
    </group>
    <group oor:name="Panel">
      <info>
        <desc>Specification of a sidebar content panel.</desc>
      </info>
      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
        <info>
          <desc>The panel title is displayed above the content panel.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="TitleBarIsOptional" oor:type="xs:boolean">
        <info>
          <desc>When true then the title bar can be omitted when the panel is the only panel in a deck.</desc>
        </info>
        <value>false</value>
      </prop>
      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
        <info>
          <desc>Internally used to identify the panel.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="DeckId" oor:type="xs:string" oor:localized="false">
        <info>
          <desc>Id of the deck to which the panel belongs.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="TitleBarIconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the title bar of the panel.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="HighContrastTitleBarIconURL" oor:type="xs:string">
        <info>
          <desc>This icon is displayed in the title bar of the panel when high contrast mode is active.
          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="HelpURL" oor:type="xs:string">
        <info>
          <desc>Help about the sidebar content panel.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="DefaultMenuCommand" oor:type="xs:string">
        <info><desc>
          The default UNO command to execute when the user clicks on the menu button in the panel title bar.
          Can be overridden in the ContextList to provide context dependent menu dialogs.
          When empty then the menu icon is not shown in the panel title bar.
        </desc></info>
        <value></value>
      </prop>
      <prop oor:name="ContextList" oor:type="oor:string-list">
        <info>
          <desc>For documentation, please see the Deck/ContextList.</desc>
        </info>
      </prop>
      <prop oor:name="ImplementationURL" oor:type="xs:string">
        <info>
          <desc>URL by which the implementation of the panel is known by its factory.</desc>
        </info>
        <value></value>
      </prop>
      <prop oor:name="OrderIndex" oor:type="xs:int">
        <info>
          <desc>Index used for ordering panels inside a deck.  Smaller values correspond to positions nearer to the top of the deck.</desc>
        </info>
        <value>10000</value>
      </prop>
      <prop oor:name="ShowForReadOnlyDocument" oor:type="xs:boolean">
        <info>
          <desc>This flag controls whether the panel is shown when the document in the edit view is read only.</desc>
        </info>
        <value>false</value>
      </prop>
      <prop oor:name="WantsCanvas" oor:type="xs:boolean">
        <info>
          <desc>Experimental: Set to true when panel wants to paint its content via a XCanvas.</desc>
        </info>
        <value>false</value>
      </prop>
      <prop oor:name="IsExperimental" oor:type="xs:boolean">
        <info>
          <desc>This flag controls whether the panel is experimental and is shown only when experimental mode is enabled.</desc>
        </info>
        <value>false</value>
      </prop>
    </group>
  </templates>
  <component>
    <group oor:name="General">
      <info>
        <desc>General Sidebar settings.</desc>
      </info>
      <prop oor:name="MaximumWidth" oor:type="xs:int" oor:nillable="false">
        <info>
          <desc>Maximum width the sidebar can have.
          Note that this can be overridden by extensions returning a larger value in XSidebarPanel::getMinimalWidth()</desc>
        </info>
        <value>500</value>
      </prop>
      <prop oor:name="MinimumWidth" oor:type="xs:boolean" oor:nillable="false">
        <info>
          <desc>Minimum width the sidebar can have. If true, the minumum width
          is calculated from the largest deck.</desc>
        </info>
        <value>true</value>
      </prop>
    </group>
    <group oor:name="Content">
      <info>
        <desc>Description of the decks and panels that can be displayed in the content area of the sidebar.</desc>
      </info>
      <set oor:name="DeckList" oor:node-type="Deck">
        <info>
          <desc>Contains all registered sidebar decks.</desc>
        </info>
      </set>
      <set oor:name="PanelList" oor:node-type="Panel">
        <info>
          <desc>Contains all registered sidebar content panels.</desc>
        </info>
      </set>
      <prop oor:name="LastActiveDeck" oor:type="oor:string-list" oor:nillable="false">
        <info>
	  <desc>Contains IDs of the decks that were active last time the application was closed.
	    Each entry is a string of 2 comma-separated values, application name and DeckID. Valid
	    values for application name are the same as those in ContextList, for example:

	    WriterVariants, StyleListDeck;
	    Impress, PropertyDeck;
	  </desc>
	</info>
	<value>
	  <it>any,PropertyDeck</it>
	</value>
      </prop>
    </group>
  </component>
</oor:component-schema>