xref: /AOO41X/main/officecfg/registry/schema/org/openoffice/Office/Addons.xcs (revision ff0525f24f03981d56b7579b645949f111420994)
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="Addons" oor:package="org.openoffice.Office" xml:lang="en-US"> <info>
26        <author>CD</author>
27        <desc >Contains general structures used to integrate external components into the Office user interface.</desc>
28    </info>
29    <templates>
30        <group oor:name="MenuItem">
31            <info>
32                <desc>Describes a menu item representing a function of of an external component. The name must be unique and should be written using a package-scheme like org.openoffice.external.applicationexecuter to minimize name clashes.</desc>
33            </info>
34            <prop oor:name="URL" oor:type="xs:string">
35                <info>
36                    <desc>A command URL which represents the function to execute.</desc>
37                </info>
38            </prop>
39            <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
40                <info>
41                    <desc>A localized string used to as the menu item title.</desc>
42                </info>
43            </prop>
44            <prop oor:name="ImageIdentifier" oor:type="xs:string">
45                <info>
46                    <desc>A private URL used to reference an optional internal menu image. Example: private:image/3216 addresses the internal Office image with id=3216.</desc>
47                </info>
48            </prop>
49            <prop oor:name="Target" oor:type="xs:string">
50                <info>
51                    <desc>This is the target URL which is used for the dispatch command. There are special URL's to address certain targets: _self, current frame; _default, default; _blank, create new frame.</desc>
52                </info>
53            </prop>
54            <prop oor:name="Context" oor:type="xs:string">
55                <info>
56                    <desc>An property to define the context of a menu item that has a sub menu. It can be empty or a colon separated list of the supported application modules.</desc>
57                </info>
58            </prop>
59            <set oor:name="Submenu" oor:node-type="MenuItem">
60                <info>
61                    <desc>An optional set to allow sub menus.</desc>
62                </info>
63            </set>
64        </group>
65        <group oor:name="PopupMenu">
66            <info>
67                <desc>Describes a menu item/toolbar item representing a function of an external component. The name must be unique and should be written using a package-scheme like org.openoffice.external.applicationexecuter to minimize name clashes.</desc>
68            </info>
69            <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
70                <info>
71                    <desc>A localized string used to as the menu title.</desc>
72                </info>
73            </prop>
74            <prop oor:name="Context" oor:type="xs:string">
75                <info>
76                    <desc>An property to define the context of a top-level popup-menu . It can be empty or a colon separated list of the supported application modules.</desc>
77                </info>
78            </prop>
79            <set oor:name="Submenu" oor:node-type="MenuItem">
80                <info>
81                    <desc>An optional set to allow sub menus. This property cannot be used for toolbar item definitions.</desc>
82                </info>
83            </set>
84        </group>
85        <group oor:name="MergeMenuInstruction">
86            <info>
87                <desc>Describes a merge menu instruction of an external component. The name must be unique and should be written using a package-scheme like org.openoffice.external.applicationexecuter to minimize name clashes. A menu instruction describes how the attached menu items should be merged into the Office menubar.</desc>
88            </info>
89            <prop oor:name="MergePoint" oor:type="xs:string">
90                <info>
91                    <desc>A command path describe the reference point for the merge command.</desc>
92                </info>
93            </prop>
94            <prop oor:name="MergeCommand" oor:type="xs:string">
95                <info>
96                    <desc>A command to be processed for this merge menu instruction.</desc>
97                </info>
98            </prop>
99            <prop oor:name="MergeCommandParameter" oor:type="xs:string">
100                <info>
101                    <desc>Optional parameters for a merge command. Interpretation depends on the individual command.</desc>
102                </info>
103            </prop>
104            <prop oor:name="MergeFallback" oor:type="xs:string">
105                <info>
106                    <desc>A fallback command to be used if MergeCommand cannot be applied.</desc>
107                </info>
108            </prop>
109            <prop oor:name="MergeContext" oor:type="xs:string">
110                <info>
111                    <desc>A property to define the context of this merge instruction. It can be empty or a colon separated list of the supported application modules.</desc>
112                </info>
113            </prop>
114            <set oor:name="MenuItems" oor:node-type="MenuItem">
115                <info>
116                    <desc>Defines the menu item(s) to be merged into the menu bar.</desc>
117                </info>
118            </set>
119        </group>
120        <group oor:name="MergeToolBarInstruction">
121            <info>
122                <desc>Describes a merge menu instruction of an external component. The name must be unique and should be written using a package-scheme like org.openoffice.external.applicationexecuter to minimize name clashes. A menu instruction describes how the attached menu items should be merged into the Office menubar.</desc>
123            </info>
124            <prop oor:name="MergeToolBar" oor:type="xs:string">
125                <info>
126                    <desc>Defines the toolbar resource URL.</desc>
127                </info>
128            </prop>
129            <prop oor:name="MergePoint" oor:type="xs:string">
130                <info>
131                    <desc>Describes the command that should be used as a reference point for the merge command.</desc>
132                </info>
133            </prop>
134            <prop oor:name="MergeCommand" oor:type="xs:string">
135                <info>
136                    <desc>A command to be processed for this merge menu instruction.</desc>
137                </info>
138            </prop>
139            <prop oor:name="MergeCommandParameter" oor:type="xs:string">
140                <info>
141                    <desc>Optional parameters for a merge command. Interpretation depends on the individual command.</desc>
142                </info>
143            </prop>
144            <prop oor:name="MergeFallback" oor:type="xs:string">
145                <info>
146                    <desc>A fallback command to be used if MergeCommand cannot be applied.</desc>
147                </info>
148            </prop>
149            <prop oor:name="MergeContext" oor:type="xs:string">
150                <info>
151                    <desc>A property to define the context of this merge instruction. It can be empty or a colon separated list of the supported application modules.</desc>
152                </info>
153            </prop>
154            <set oor:name="ToolBarItems" oor:node-type="ToolBarItem">
155                <info>
156                    <desc>Contains a list of toolbar items used by an Add-On.</desc>
157                </info>
158            </set>
159        </group>
160        <group oor:name="ToolBarItem">
161            <info>
162                <desc>Describes a toolbar item representing a function of of an external component. The name must be unique and should be written using a package-scheme like org.openoffice.external.applicationexecuter to minimize name clashes.</desc>
163            </info>
164            <prop oor:name="URL" oor:type="xs:string">
165                <info>
166                    <desc>A command URL which represents the function to execute.</desc>
167                </info>
168            </prop>
169            <prop oor:name="Title" oor:type="xs:string" oor:localized="true">
170                <info>
171                    <desc>A localized string used to as the menu item title.</desc>
172                </info>
173            </prop>
174            <prop oor:name="ImageIdentifier" oor:type="xs:string">
175                <info>
176                    <desc>A private URL used to reference an optional internal menu image. Example: private:image/3216 addresses the internal Office image with id=3216.</desc>
177                </info>
178            </prop>
179            <prop oor:name="Target" oor:type="xs:string">
180                <info>
181                    <desc>This is the target URL which is used for the dispatch command. There are special URL's to address certain targets: _self, current frame; _default, default; _blank, create new frame.</desc>
182                </info>
183            </prop>
184            <prop oor:name="Context" oor:type="xs:string">
185                <info>
186                    <desc>A property to define the context of a toolbar item. It can be empty or a colon separated list of the supported application modules.</desc>
187                </info>
188            </prop>
189            <prop oor:name="ControlType" oor:type="xs:string">
190                <info>
191                    <desc>A property to define the control type of the toolbar item. An will be interpreted as OpenOffice.org default toggle button.</desc>
192                </info>
193            </prop>
194            <prop oor:name="Width" oor:type="xs:long">
195                <info>
196                    <desc>A property to define the size of a toolbar item. This property works only ControlTypes which can have a dynamic size (e.g. comboboxes, edit fields, spin fields)</desc>
197                </info>
198            </prop>
199        </group>
200        <group oor:name="UserDefinedImages">
201            <info>
202                <desc>A group of optional user-defined images. There are two ways to define image - 1. Embed the image data directly into the configuration. 2. Use file URLs to address external bitmap files. Embedded image data has a higher priority than file URLs.</desc>
203            </info>
204            <prop oor:name="ImageSmall" oor:type="xs:hexBinary">
205                <info>
206                    <desc>Binary bitmap data used for menu images and small toolbox buttons. Standard size of a small image is 16x16 pixel.</desc>
207                </info>
208            </prop>
209            <prop oor:name="ImageBig" oor:type="xs:hexBinary">
210                <info>
211                    <desc>Binary bitmap data used for big toolbox buttons. Standard size of a big image is 26x26 pixel.</desc>
212                </info>
213            </prop>
214            <prop oor:name="ImageSmallHC" oor:type="xs:hexBinary">
215                <info>
216                    <desc>Binary bitmap data used for high contrast displays. Standard size of a small image is 16x16 pixel.</desc>
217                </info>
218            </prop>
219            <prop oor:name="ImageBigHC" oor:type="xs:hexBinary">
220                <info>
221                    <desc>Binary bitmap data used for high contrast displays. Standard size of a big image is 26x26 pixel.</desc>
222                </info>
223            </prop>
224            <prop oor:name="ImageSmallURL" oor:type="xs:string">
225                <info>
226                    <desc>A file URL to address a external bitmap file used for menu images and/or small toolbox buttons. Standard size of an small image is 16x16 pixel.</desc>
227                </info>
228            </prop>
229            <prop oor:name="ImageBigURL" oor:type="xs:string">
230                <info>
231                    <desc>A file URL to address a external bitmap file used for big toolbox buttons. Standard size of an big image is 26x26 pixel.</desc>
232                </info>
233            </prop>
234            <prop oor:name="ImageSmallHCURL" oor:type="xs:string">
235                <info>
236                    <desc>A file URL to address a external bitmap file used for high contrast menu images and/or toolbox buttons. Standard size of an small image is 16x16 pixel.</desc>
237                </info>
238            </prop>
239            <prop oor:name="ImageBigHCURL" oor:type="xs:string">
240                <info>
241                    <desc>A file URL to address a external bitmap file used for big high contrast toolbox buttons. Standard size of an big image is 26x26 pixel.</desc>
242                </info>
243            </prop>
244        </group>
245        <group oor:name="Images">
246            <info>
247                <desc>A group that associates images to a command URL</desc>
248            </info>
249            <prop oor:name="URL" oor:type="xs:string">
250                <info>
251                    <desc>The command URL that is bound to the defined images.</desc>
252                </info>
253            </prop>
254            <node-ref oor:name="UserDefinedImages" oor:node-type="UserDefinedImages">
255                <info>
256                    <desc>An user-defined images group.</desc>
257                </info>
258            </node-ref>
259        </group>
260        <set oor:name="ToolBarItems" oor:node-type="ToolBarItem">
261            <info>
262                <desc>Contains a list of toolbar items used by an Add-On.</desc>
263            </info>
264        </set>
265        <set oor:name="MergeMenuItems" oor:node-type="MergeMenuInstruction">
266            <info>
267                <desc>Contains a list of merge menu instructions defined by an Add-On which specify how to merge menu items into the Office menubar.</desc>
268            </info>
269        </set>
270        <set oor:name="MergeToolBarItems" oor:node-type="MergeToolBarInstruction">
271            <info>
272                <desc>Contains a list of merge toolbar instructions defined by an Add-On which specify how to merge toolbar items into an existing toolbar.</desc>
273            </info>
274        </set>
275    </templates>
276    <component>
277        <group oor:name="AddonUI">
278            <info>
279                <desc>Contains information about the structure of addon user interface.</desc>
280            </info>
281            <set oor:name="AddonMenu" oor:node-type="MenuItem">
282                <info>
283                    <desc>Contains the structure of the addon menu used by the Office. It provide functions of external components to the user.</desc>
284                </info>
285            </set>
286            <set oor:name="Images" oor:node-type="Images">
287                <info>
288                    <desc>Contains the structure for user-defined images which can be used by menu items and toolbar buttons.</desc>
289                </info>
290            </set>
291            <set oor:name="OfficeMenuBar" oor:node-type="PopupMenu">
292                <info>
293                    <desc>Contains the structure of addon popup-menus inserted into the Office menubar. It provide functions of external components to the user.</desc>
294                </info>
295            </set>
296            <set oor:name="OfficeMenuBarMerging" oor:node-type="MergeMenuItems">
297                <info>
298                    <desc>Contains a list of menu merging instructions of different add-ons.</desc>
299                </info>
300            </set>
301            <set oor:name="OfficeToolBar" oor:node-type="ToolBarItems">
302                <info>
303                    <desc>Contains a list of sets of toolbar items that are part of add-on toolbars.</desc>
304                </info>
305            </set>
306            <set oor:name="OfficeToolbarMerging" oor:node-type="MergeToolBarItems">
307                <info>
308                    <desc>Contains a list of toolbar merging instructions of different add-ons. </desc>
309                </info>
310            </set>
311            <set oor:name="OfficeHelp" oor:node-type="MenuItem">
312                <info>
313                    <desc>Contains a list of functions inserted into the Office help menu. The optional property 'Submeno' will be ignored for this set.</desc>
314                </info>
315            </set>
316        </group>
317    </component>
318</oor:component-schema>
319