xref: /AOO41X/main/officecfg/registry/schema/org/openoffice/Office/UI/Sidebar.xcs (revision 47148b3bc50811ceb41802e4cc50a5db21535900)
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
26    xmlns:oor="http://openoffice.org/2001/registry"
27    xmlns:xs="http://www.w3.org/2001/XMLSchema"
28    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
29    oor:name="Sidebar"
30    oor:package="org.openoffice.Office.UI"
31    xml:lang="en-US">
32  <info>
33    <author>Andre Fischer</author>
34    <desc>Specification of decks and content panels of the sidebar.</desc>
35  </info>
36  <templates>
37    <group oor:name="Deck">
38      <info>
39        <desc>Specification of a sidebar deck which is a container of content panels.</desc>
40      </info>
41      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
42        <info>
43          <desc>The deck title is displayed above the content panels.</desc>
44        </info>
45        <value></value>
46      </prop>
47      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
48        <info>
49          <desc>Internally used to identify the deck.  Not displayed in the UI.</desc>
50        </info>
51        <value></value>
52      </prop>
53      <prop oor:name="IconURL" oor:type="xs:string">
54        <info>
55          <desc>This icon is displayed in the sidebar tab bar.
56          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
57        </info>
58        <value></value>
59      </prop>
60      <prop oor:name="HighContrastIconURL" oor:type="xs:string">
61        <info>
62          <desc>This icon is displayed in the sidebar tab bar when high contrast mode is active.
63          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
64        </info>
65        <value></value>
66      </prop>
67      <prop oor:name="HelpURL" oor:type="xs:string">
68        <info>
69          <desc>Help about the sidebar deck.</desc>
70        </info>
71        <value></value>
72      </prop>
73      <prop oor:name="ContextList" oor:type="oor:string-list">
74        <info><desc>
75          List of context descriptors.  Each context descriptor is a string that contains four comma
76          separated values (note that values are case sensitive):
77          1  Application name. Valid values are
78                 com.sun.star.text.TextDocument
79                 com.sun.star.sheet.SpreadsheetDocument
80                 com.sun.star.presentation.PresentationDocument
81                 com.sun.star.drawing.DrawingDocument
82
83             Recognized shortcuts:
84                 Writer
85                 Calc
86                 Impress
87                 Draw
88
89             Shortcuts for multiple applications:
90                 DrawImpress
91                 WriterAndWeb
92             These shortcuts exist for even more convenience and handle the frequent case of Draw
93         and Impress as well as Writer and WriterWeb having otherwise identical context descriptions.
94
95             Special values:
96                 any
97                 none
98
99          2  Context name
100              Know context names are 3DObject, Annotation, Auditing, Cell, Chart, Draw, DrawPage, DrawText,
101              EditCell, Form, Frame, Graphic, HandoutPage, MasterPage, Media, Multiobj, OLE, OutlineText,
102              Pivot, SlidesorterPage, Table, Text, TextObject,
103              default
104
105             Special values:
106                 any
107
108          3  Panel state.  One of
109             visible  Panel is initially visible and expanded
110             hidden   Panel is initially collapsed, ie only its title bar is visible
111
112          4  (Optional, only used for panels) UNO command that overrides the DefaultMenuCommand.  Use
113             the special value none to override the DefaultMenuCommand to the empty string and thereby
114             disable the showing of a) the menu button in the panel titlebar and b) the showing of a dialog.
115        </desc></info>
116      </prop>
117      <prop oor:name="OrderIndex" oor:type="xs:int">
118        <info>
119          <desc>Index used for ordering decks in the tab bar.  Smaller values correspond to positions nearer to the top of the tab bar.</desc>
120        </info>
121        <value>10000</value>
122      </prop>
123    </group>
124    <group oor:name="Panel">
125      <info>
126        <desc>Specification of a sidebar content panel.</desc>
127      </info>
128      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
129        <info>
130          <desc>The panel title is displayed above the content panel.</desc>
131        </info>
132        <value></value>
133      </prop>
134      <prop oor:name="TitleBarIsOptional" oor:type="xs:boolean">
135        <info>
136          <desc>When true then the title bar can be ommitted when the panel is the only panel in a deck.</desc>
137        </info>
138        <value>false</value>
139      </prop>
140      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
141        <info>
142          <desc>Internally used to identify the panel.</desc>
143        </info>
144        <value></value>
145      </prop>
146      <prop oor:name="DeckId" oor:type="xs:string" oor:localized="false">
147        <info>
148          <desc>Id of the deck to which the panel belongs.</desc>
149        </info>
150        <value></value>
151      </prop>
152      <prop oor:name="HelpURL" oor:type="xs:string">
153        <info>
154          <desc>Help about the sidebar content panel.</desc>
155        </info>
156        <value></value>
157      </prop>
158      <prop oor:name="DefaultMenuCommand" oor:type="xs:string">
159        <info><desc>
160          The default UNO command to execute when the user clicks on the menu button in the panel title bar.
161          Can be overriden in the ContextList to provide context dependent menu dialogs.
162          When empty then the menu icon is not shown in the panel title bar.
163        </desc></info>
164        <value></value>
165      </prop>
166      <prop oor:name="ContextList" oor:type="oor:string-list">
167        <info>
168          <desc>For documentation, please see the Deck/ContextList.</desc>
169        </info>
170      </prop>
171      <prop oor:name="ImplementationURL" oor:type="xs:string">
172        <info>
173          <desc>URL by which the implementation of the panel is known by its factory.</desc>
174        </info>
175        <value></value>
176      </prop>
177      <prop oor:name="OrderIndex" oor:type="xs:int">
178        <info>
179          <desc>Index used for ordering panels inside a deck.  Smaller values correspond to positions nearer to the top of the deck.</desc>
180        </info>
181        <value>10000</value>
182      </prop>
183      <prop oor:name="WantsCanvas" oor:type="xs:boolean">
184        <info>
185          <desc>Experimental: Set to true when panel wants to paint its content via a XCanvas.</desc>
186        </info>
187        <value>false</value>
188      </prop>
189    </group>
190  </templates>
191  <component>
192    <group oor:name="Content">
193      <info>
194        <desc>Description of the decks and panels that can be displayed in the content area of the sidebar.</desc>
195      </info>
196      <set oor:name="DeckList" oor:node-type="Deck">
197        <info>
198          <desc>Contains all registered sidebar decks.</desc>
199        </info>
200      </set>
201      <set oor:name="PanelList" oor:node-type="Panel">
202        <info>
203          <desc>Contains all registered sidebar content panels.</desc>
204        </info>
205      </set>
206    </group>
207  </component>
208</oor:component-schema>
209