xref: /AOO41X/main/officecfg/registry/schema/org/openoffice/Office/UI/Sidebar.xcs (revision 8dcb2a100eb78f12871a9e67d867e1bc0c7bdb07)
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="ContextMatcherType">
38      <info>
39        <desc>A context specifies the combination of one application name and one or more
40        context names (eg cursor in table, selection active, text editing active).</desc>
41      </info>
42      <prop oor:name="Application" oor:type="xs:string" oor:localized="false">
43        <info>
44          <desc>Name of the application.  Known values are:
45          any,
46          com.sun.star.text.TextDocument (Writer),
47          com.sun.star.sheet.SpreadsheetDocument (Calc),
48          com.sun.star.presentation.PresentationDocument (Impress),
49          com.sun.star.drawing.DrawingDocument (Draw)</desc>
50        </info>
51      </prop>
52      <prop oor:name="IsContextListNegated" oor:type="xs:boolean">
53        <info>
54          <desc>Use this to match the complement of the listed contexts.  The application match is not negated.
55          Defaults to false (ie match the contexts as listed).</desc>
56        </info>
57        <value>false</value>
58      </prop>
59      <prop oor:name="ContextList" oor:type="oor:string-list" oor:localized="false">
60        <info>
61          <desc>Names of application specific contexts.  The special name "any" matches any context name.</desc>
62        </info>
63      </prop>
64    </group>
65    <group oor:name="Deck">
66      <info>
67        <desc>Specification of a sidebar deck which is a container of content panels.</desc>
68      </info>
69      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
70        <info>
71          <desc>The deck title is displayed above the content panels.</desc>
72        </info>
73        <value></value>
74      </prop>
75      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
76        <info>
77          <desc>Internally used to identify the deck.  Not displayed in the UI.</desc>
78        </info>
79        <value></value>
80      </prop>
81      <prop oor:name="IconURL" oor:type="xs:string">
82        <info>
83          <desc>This icon is displayed in the sidebar tab bar.
84          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
85        </info>
86        <value></value>
87      </prop>
88      <prop oor:name="HighContrastIconURL" oor:type="xs:string">
89        <info>
90          <desc>This icon is displayed in the sidebar tab bar when high contrast mode is active.
91          Any URL scheme supported by the com.sun.star.graphic.GraphicProvider service is suitable here.</desc>
92        </info>
93        <value></value>
94      </prop>
95      <prop oor:name="HelpURL" oor:type="xs:string">
96        <info>
97          <desc>Help about the sidebar deck.</desc>
98        </info>
99        <value></value>
100      </prop>
101      <set oor:name="ContextMatchers" oor:node-type="ContextMatcherType">
102        <info>
103          <desc>One or more context matchers that define when to show the deck.</desc>
104        </info>
105      </set>
106      <prop oor:name="OrderIndex" oor:type="xs:int">
107        <info>
108          <desc>Index used for ordering decks in the tab bar.  Smaller values correspond to positions nearer to the top of the tab bar.</desc>
109        </info>
110        <value>10000</value>
111      </prop>
112    </group>
113    <group oor:name="Panel">
114      <info>
115        <desc>Specification of a sidebar content panel.</desc>
116      </info>
117      <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
118        <info>
119          <desc>The panel title is displayed above the content panel.</desc>
120        </info>
121        <value></value>
122      </prop>
123      <prop oor:name="TitleBarIsOptional" oor:type="xs:boolean">
124        <info>
125          <desc>When true then the title bar can be ommitted when the panel is the only panel in a deck.</desc>
126        </info>
127        <value>false</value>
128      </prop>
129      <prop oor:name="Id" oor:type="xs:string" oor:localized="false">
130        <info>
131          <desc>Internally used to identify the panel.</desc>
132        </info>
133        <value></value>
134      </prop>
135      <prop oor:name="DeckId" oor:type="xs:string" oor:localized="false">
136        <info>
137          <desc>Id of the deck to which the panel belongs.</desc>
138        </info>
139        <value></value>
140      </prop>
141      <prop oor:name="HelpURL" oor:type="xs:string">
142        <info>
143          <desc>Help about the sidebar content panel.</desc>
144        </info>
145        <value></value>
146      </prop>
147      <set oor:name="ContextMatchers" oor:node-type="ContextMatcherType">
148        <info>
149          <desc>One or more context matchers that define when to show the panel.</desc>
150        </info>
151      </set>
152      <prop oor:name="AskPanelForContextMatcher" oor:type="xs:boolean">
153        <info>
154          <desc>Sometimes the context matcher in the registry is too simple.  In that case the panel can implement the XSidebarPanel interface and provide a more complex matcher in its isContextSupported() method.  That method is only called when the value of this AsPanel property is set to true.
155          Defaults to false.</desc>
156        </info>
157        <value>false</value>
158      </prop>
159      <prop oor:name="ImplementationURL" oor:type="xs:string">
160        <info>
161          <desc>URL by which the implementation of the panel is known by its factory.</desc>
162        </info>
163        <value></value>
164      </prop>
165      <prop oor:name="IsExpandedByDefault" oor:type="xs:boolean">
166        <info>
167          <desc>When true then the panel is initialized in its expanded state.</desc>
168        </info>
169        <value>true</value>
170      </prop>
171      <prop oor:name="OrderIndex" oor:type="xs:int">
172        <info>
173          <desc>Index used for ordering panels inside a deck.  Smaller values correspond to positions nearer to the top of the deck.</desc>
174        </info>
175        <value>10000</value>
176      </prop>
177      <prop oor:name="HasMenu" oor:type="xs:boolean">
178        <info>
179          <desc>When true then the panel title bar displays a menu button. When clicked the ui::XSidebarPanel::showmenu() method is called.</desc>
180        </info>
181        <value>false</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