Warning, /frameworks/kxmlgui/src/kpartgui.dtd is written in an unsupported language. File is not indexed.

0001 <!-- Originally Copyright (c) 2000 Federico David Sacerdoti <tech@slinuxmachines.com>
0002      Modifications/Extensions by Simon Hausmann <hausmann@kde.org>
0003      Minor updates by Richard J. Moore <rich@kde.org>
0004 
0005   This DTD module is identified by the PUBLIC and SYSTEM
0006   identifiers:
0007   PUBLIC  "-//KDE Project//KPartGUI DTD//EN"
0008   SYSTEM "kpartgui.dtd"
0009 
0010   This DTD should be included at the head of an xmlguibuilder XML file like this:
0011   <!DOCTYPE gui SYSTEM "kpartgui.dtd">
0012 
0013   When using the old deprecated root element <kpartgui>,
0014   the respective doctype name must be used, like this:
0015   <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
0016 -->
0017 
0018 <!--The root element that must enclose all other tags in the document. This element
0019   replaces the kpartgui element used previously.
0020 
0021   NOTE: do not forget to increase the version attribute for each change in
0022   your file or the changes will not be taken!!
0023   -->
0024 <!ELEMENT gui ((ActionProperties | MenuBar | ToolBar | Merge | MergeLocal | DefineGroup | MainWindow | StatusBar | Menu | State)*)>
0025 <!ATTLIST gui
0026   name CDATA #REQUIRED
0027   version CDATA #REQUIRED
0028   library CDATA #IMPLIED
0029   translationDomain CDATA #IMPLIED
0030 >
0031 
0032 <!-- DEPRECATED: The old root element that must enclose all other tags in the document. -->
0033 <!ELEMENT kpartgui ((ActionProperties | MenuBar | ToolBar | Merge | MergeLocal | DefineGroup | MainWindow | StatusBar | Menu | State)*)>
0034 <!ATTLIST kpartgui
0035   name CDATA #REQUIRED
0036   version CDATA #REQUIRED
0037   library CDATA #IMPLIED
0038   translationDomain CDATA #IMPLIED
0039 >
0040 
0041 <!-- Allows standard actions to be customized -->
0042 <!ELEMENT ActionProperties (Action+)>
0043 
0044 <!-- A menu bar -->
0045 <!ELEMENT MenuBar ((Menu | Separator | Action | ActionList | Merge | MergeLocal | DefineGroup )*)>
0046 <!ATTLIST MenuBar
0047   name CDATA #IMPLIED
0048   group CDATA #IMPLIED
0049 >
0050 
0051 <!-- A tool bar
0052   - Attributes: name: a unique name for the toolbar, use mainToolBar for the main one
0053   -             position: the position of the toolbar in the window (only effective if the user
0054                           has never used the application before)
0055   -             iconText: whether to show icon or text or both
0056   -             iconSize: the size of the icons (0 for default, or usually 22 or 32)
0057   -             index: the index in the toolbar dock (see QMainWindow::moveToolBar; starts at 0)
0058   -             offset: the X offset in the toolbar dock (see QMainWindow::moveToolBar)
0059   -             newline: if true, this toolbar will start a new line (i.e. under the ones before it).
0060   -             group: optional group name, for named merging (?)
0061   -             hidden: if true, the toolbar is initially hidden. There should be a menu entry for showing it.
0062   -             noEdit: if true, the toolbar won't appear in the toolbar editor
0063   -             noMerge: if true, the standard toolbar layout from ui_standards.rc won't be used.
0064   -             deleted: if true, the toolbar will not be created, even if ui_standards.rc mentions it
0065   -->
0066 <!ELEMENT ToolBar (text?, (Action | Separator | ActionList | Merge | MergeLocal | DefineGroup)*)>
0067 <!ATTLIST ToolBar
0068   name CDATA #REQUIRED
0069   position (top|bottom|left|right) "top"
0070   iconText (icononly|textonly|icontextright|icontextbottom) #IMPLIED
0071   iconSize CDATA #IMPLIED
0072   index CDATA #IMPLIED
0073   offset CDATA #IMPLIED
0074   newline (true|false) "false"
0075   group CDATA #IMPLIED
0076   hidden (true|false) "false"
0077   noEdit (true|false) "false"
0078   noMerge (0|1) "0"
0079   deleted (true|false) "false"
0080 >
0081 
0082 <!-- A Menu such as the "File" or "Edit" menu. Can be used to define popup menus as well.
0083   -             noMerge: if true, the standard menu layout from ui_standards.rc won't be used.
0084   -             deleted: if true, the menu will not be created, even if ui_standards.rc mentions it
0085 -->
0086 <!ELEMENT Menu (text?, (title | Action | ActionList | Separator | TearOffHandle | Merge | MergeLocal | DefineGroup | Menu )*)>
0087 <!ATTLIST Menu
0088   append CDATA #IMPLIED
0089   name CDATA #REQUIRED
0090   group CDATA #IMPLIED
0091   icon CDATA #IMPLIED
0092   noMerge (0|1) "0"
0093   deleted (true|false) "false"
0094 >
0095 
0096 <!-- Defines both Standard and app-specific actions. An action can appear in a menu, a toolbar or in a
0097      menubar.
0098      Attributes:
0099      - name of the action: this is matched with the KAction name.
0100      - group: this is used to control the placement of the action when merging
0101               e.g. a part, it matches the name of a DefineGroup in the mainwindow's rc file.
0102      - append: this is used to control the placement of the action during the
0103                merging with ui_standards.rc. This is mapped to MergeLocal tags there.
0104                Note that this feature is currently only available for the mainwindow, not for parts/plugins.
0105      - text, whatsThis, toolTip, iconText, shortcut, icon, priority: all those are mapped
0106        to KAction properties.
0107  -->
0108 <!ELEMENT Action EMPTY>
0109 <!-- We defined only a few standard KAction properties here. Theoritically we can have
0110      any property here -->
0111 <!ATTLIST Action
0112   name CDATA #REQUIRED
0113   group CDATA #IMPLIED
0114   append CDATA #IMPLIED
0115   text CDATA #IMPLIED
0116   whatsThis CDATA #IMPLIED
0117   toolTip CDATA #IMPLIED
0118   iconText CDATA #IMPLIED
0119   shortcut CDATA #IMPLIED
0120   icon CDATA #IMPLIED
0121   priority CDATA #IMPLIED
0122 >
0123 
0124 <!-- Inserts a separator item into a menubar or toolbar -->
0125 <!ELEMENT Separator EMPTY>
0126 <!ATTLIST Separator
0127   lineSeparator (true|false) "true"
0128   weakSeparator (true|false) "true"
0129   append CDATA #IMPLIED
0130   group CDATA #IMPLIED
0131 >
0132 
0133 <!-- Inserts a tear-off handle into a menu -->
0134 <!ELEMENT TearOffHandle EMPTY>
0135 <!ATTLIST TearOffHandle
0136   group CDATA #IMPLIED
0137 >
0138 
0139 <!-- Used to insert titles, only for popup menus -->
0140 <!ELEMENT title (#PCDATA)>
0141 <!ATTLIST title
0142   translationDomain CDATA #IMPLIED
0143   icon CDATA #IMPLIED
0144 >
0145 
0146 <!-- Used to name a menu, the first letter in is generally preceded by an '&' to specify
0147   the menu's shortcut key -->
0148 <!ELEMENT text (#PCDATA)>
0149 <!ATTLIST text
0150   translationDomain CDATA #IMPLIED
0151   context CDATA #IMPLIED
0152 >
0153 
0154 <!-- Specifies a dynamic list of actions, each of which can be changed by plugging/unplugging it -->
0155 <!ELEMENT ActionList EMPTY>
0156 <!ATTLIST ActionList
0157   name CDATA #REQUIRED
0158 >
0159 
0160 <!-- Not explicitly defined or in widely used yet. -->
0161 <!ELEMENT MainWindow ANY>
0162 
0163 <!-- Not explicitly defined or in widely used yet. -->
0164 <!ELEMENT StatusBar ANY>
0165 
0166 <!-- Specifies the entry index for merging in a gui client -->
0167 <!ELEMENT Merge EMPTY>
0168 <!ATTLIST Merge
0169   name CDATA #IMPLIED
0170 >
0171 
0172 <!-- Specifies an entry index for merging application defined actions into
0173      those with positions fixed by the style guide and ui_standards.rc. This
0174      tag should not be used anywhere except ui_standards.rc. -->
0175 <!ELEMENT MergeLocal EMPTY>
0176 <!ATTLIST MergeLocal
0177   name CDATA #IMPLIED
0178 >
0179 
0180 <!-- Specifies a entry index for merging, similar to the Merge tag, but with a global scope and
0181      accessible via the group attribute of other tags -->
0182 <!ELEMENT DefineGroup EMPTY>
0183 <!ATTLIST DefineGroup
0184   name CDATA #REQUIRED
0185 >
0186 
0187 <!-- Defines a GUI state, esp. which actions to enable and which ones to -->
0188 <!-- disable on entering this state (see KXMLGUIClient::stateChanged())  -->
0189 <!ELEMENT State ( (enable, disable?) | disable )>
0190 <!ATTLIST State
0191   name CDATA #REQUIRED
0192 >
0193 
0194 <!-- used in State to collect actions to be enabled and disabled, resp., -->
0195 <!-- on entering the state -->
0196 <!ELEMENT enable (Action+)>
0197 <!ELEMENT disable (Action+)>