Development/Architecture/KDE4/XMLGUI Technology - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T18:41:31Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T18:37:46Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 18:37, 29 June 2011
			
Line 135:
Line 135:
  * Actions from component_a.rc are placed below actions from main_ui.rc, because MyComponentA gets added after MyMainWindow. Similarily, actions from component_b.rc are placed below those from main_ui.rc and component_a.rc.   * Actions from component_a.rc are placed below actions from main_ui.rc, because MyComponentA gets added after MyMainWindow. Similarily, actions from component_b.rc are placed below those from main_ui.rc and component_a.rc.
  * When component_a.rc is read, a menu named "menu2" already exist, and is therefore merged with the existing one. Due to this, "menu3" gets appended at the end of the menubar, instead of between "menu1" and "menu2". Similarily the order of the definition of the menus in component_b.rc is effectively ignored, because those menus have already been defined, previously.   * When component_a.rc is read, a menu named "menu2" already exist, and is therefore merged with the existing one. Due to this, "menu3" gets appended at the end of the menubar, instead of between "menu1" and "menu2". Similarily the order of the definition of the menus in component_b.rc is effectively ignored, because those menus have already been defined, previously.
− * {{Note|When using several clients in a single application, each should be given a unique name as specified using <code xml><gui name="..."></code>. Otherwise you will experience strange subtle problems.}} + * {{Note|When using several clients in a single application, each should be given a unique name as specified using <syntaxhighlight lang="xml"><gui name="..."></code>. Otherwise you will experience strange subtle problems.}}
    
  == Elements to control merging ==   == Elements to control merging ==



Nicolas17: update to new syntaxhighlighter
2011-06-27T19:31:22Z
update to new syntaxhighlighter
Show changes


Shentey: update remaining links to git repository
2011-06-23T19:21:43Z
update remaining links to git repository

				
				
				
				
			
			← Older revision
			Revision as of 19:21, 23 June 2011
			
Line 24:
Line 24:
    
  == How does merging happen ==   == How does merging happen ==
− The first thing that happens is that the ui.rc file of you application is merged in the KDE global [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. This is to make sure that standard elements all end up in the KDE standard places. + The first thing that happens is that the ui.rc file of you application is merged in the KDE global [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/entry/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. This is to make sure that standard elements all end up in the KDE standard places.
    
  Now, when you add further KXMLGUIClients (e.g. a KPart, or a plugin), in general the KXMLGUIFactory does the following:   Now, when you add further KXMLGUIClients (e.g. a KPart, or a plugin), in general the KXMLGUIFactory does the following:
Line 152:
Line 152:
    
  === <MergeLocal> ===   === <MergeLocal> ===
− This can only be used in the KDE global [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. It defines points where other entries can be merged in. It can be used both with a ''name''-attribute, or without (in the latter case it acts as a catch-all merge place). + This can only be used in the KDE global [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/entry/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. It defines points where other entries can be merged in. It can be used both with a ''name''-attribute, or without (in the latter case it acts as a catch-all merge place).
    
  Then, in your RC file, you can add a certain action or menu to a given MergeLocal.   Then, in your RC file, you can add a certain action or menu to a given MergeLocal.





Shentey: update link to git repository
2011-06-23T19:16:42Z
update link to git repository

				
				
				
				
			
			← Older revision
			Revision as of 19:16, 23 June 2011
			
Line 7:
Line 7:
  * [[Development/Architecture/KDE3/XMLGUI_Technology|Documentation for KDE 3 (still mostly valid)]] [http://developer.kde.org/documentation/library/kdeqt/kde3arch/xmlgui.html (Original)]   * [[Development/Architecture/KDE3/XMLGUI_Technology|Documentation for KDE 3 (still mostly valid)]] [http://developer.kde.org/documentation/library/kdeqt/kde3arch/xmlgui.html (Original)]
  * [[Development/Architecture/KDE4/KParts|KParts - perhaps the most important use case for advanced KXMLGUI stuff]]   * [[Development/Architecture/KDE4/KParts|KParts - perhaps the most important use case for advanced KXMLGUI stuff]]
− * [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/kpartgui.dtd?view=markup kpartgui / KXMLGUI document type definition] + * [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/entry/kdeui/xmlgui/kpartgui.dtd kpartgui / KXMLGUI document type definition]
  * API documentation on KXMLGUI classes   * API documentation on KXMLGUI classes
  ** {{class|KXMLGUIClient|kdelibs|4.x}} - The base class for components that use and xml-gui   ** {{class|KXMLGUIClient|kdelibs|4.x}} - The base class for components that use and xml-gui



The User: Fixed the link, but could not get “improve” working
2011-03-07T01:48:46Z
Fixed the link, but could not get “improve” working

				
				
				
				
			
			← Older revision
			Revision as of 01:48, 7 March 2011
			
Line 1:
Line 1:
− {{improve|This entire page needs a thorough review. + {{improve|This entire page needs a thorough review.}}
−   + [http://lists.kde.org/?l=kde-core-devel&m=124976855215580&w=2 These clarifications] should be incorporated into this page, in particular regarding "append" in DefineGroup.
− [[http://http://lists.kde.org/?l=kde-core-devel&m=124976855215580&w=2 These clarifications]], should be incorporated into this page, in particular regarding "append" in DefineGroup.}} + 
  {{Note|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry|Tfry]] 14:02, 22 May 2009 (UTC)}}   {{Note|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry|Tfry]] 14:02, 22 May 2009 (UTC)}}
    





Tfry: /* Merging several KXMLGUI definitions */ Add note on significance of the name-attribute.
2010-06-29T16:54:14Z
‎Merging several KXMLGUI definitions:  Add note on significance of the name-attribute.

				
				
				
				
			
			← Older revision
			Revision as of 16:54, 29 June 2010
			
Line 136:
Line 136:
  * Actions from component_a.rc are placed below actions from main_ui.rc, because MyComponentA gets added after MyMainWindow. Similarily, actions from component_b.rc are placed below those from main_ui.rc and component_a.rc.   * Actions from component_a.rc are placed below actions from main_ui.rc, because MyComponentA gets added after MyMainWindow. Similarily, actions from component_b.rc are placed below those from main_ui.rc and component_a.rc.
  * When component_a.rc is read, a menu named "menu2" already exist, and is therefore merged with the existing one. Due to this, "menu3" gets appended at the end of the menubar, instead of between "menu1" and "menu2". Similarily the order of the definition of the menus in component_b.rc is effectively ignored, because those menus have already been defined, previously.   * When component_a.rc is read, a menu named "menu2" already exist, and is therefore merged with the existing one. Due to this, "menu3" gets appended at the end of the menubar, instead of between "menu1" and "menu2". Similarily the order of the definition of the menus in component_b.rc is effectively ignored, because those menus have already been defined, previously.
  + * {{Note|When using several clients in a single application, each should be given a unique name as specified using <code xml><gui name="..."></code>. Otherwise you will experience strange subtle problems.}}
    
  == Elements to control merging ==   == Elements to control merging ==



Tfry: /* Elements to control merging */
2010-06-29T16:43:05Z
‎Elements to control merging

				
				
				
				
			
			← Older revision
			Revision as of 16:43, 29 June 2010
			
Line 140:
Line 140:
  Often times the above principles of merging are not good enough. Fortunately, there are several ways to control the details of merging.   Often times the above principles of merging are not good enough. Fortunately, there are several ways to control the details of merging.
    
− === MergeLocal / Merge === + === <Merge> ===
− {{improve|I'm not sure the info in the Merge/MergeLocal-subchapter is correct. Use with care, and please correct and expand}} + The <Merge>-tag is the most basic element to control merging. It means that any actions from child clients will be inserted at this point, instead of at the end of the respective container. This is useful especially, if you want to make sure that one or more actions always remain at the end of a menu/toolbar. To achieve this, simply use a ui.rc-file like this:
− ==== <MergeLocal> ==== +  
  + <code xml>
  +   <Menu name="my_menu"><text>&amp;Cool stuff</text>
  +     <Action name="first_action"/>
  +     <Merge/>
  +     <Action name="last_action"/>
  +   </Menu>
  + </code>
  +  
  + === <MergeLocal> ===
  This can only be used in the KDE global [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. It defines points where other entries can be merged in. It can be used both with a ''name''-attribute, or without (in the latter case it acts as a catch-all merge place).   This can only be used in the KDE global [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/ui_standards.rc?view=markup ui_standards.rc]-file. It defines points where other entries can be merged in. It can be used both with a ''name''-attribute, or without (in the latter case it acts as a catch-all merge place).
    
Line 170:
Line 179:
    
  If you want to achieve the same result from a part or plugin, you can add a ''<DefineGroup>'' section in your main window's rc file that has the desired ''append'' attribute. Then, in your part/plugin rc file you create the Action with a ''group'' attribute.   If you want to achieve the same result from a part or plugin, you can add a ''<DefineGroup>'' section in your main window's rc file that has the desired ''append'' attribute. Then, in your part/plugin rc file you create the Action with a ''group'' attribute.
−  
− ==== <Merge> ====  
− <Merge> is the counterpart to <MergeLocal> and defines what is to be merged into a <MergeLocal>-point. TODO: Is this correct, examples, with/without names?  
    
  === DefineGroup ===   === DefineGroup ===



Jucato: Changed primary link to XMLGUI to Techbase version; Secondary link to developer.kde.org
2009-12-17T05:29:02Z
Changed primary link to XMLGUI to Techbase version; Secondary link to developer.kde.org

				
				
				
				
			
			← Older revision
			Revision as of 05:29, 17 December 2009
			
Line 6:
Line 6:
  = Related information resources =   = Related information resources =
  * [[Development/Tutorials/Using_KActions|KAction tutorial]]   * [[Development/Tutorials/Using_KActions|KAction tutorial]]
− * [http://developer.kde.org/documentation/library/kdeqt/kde3arch/xmlgui.html Documentation for KDE 3 (still mostly valid)] + * [[Development/Architecture/KDE3/XMLGUI_Technology|Documentation for KDE 3 (still mostly valid)]] [http://developer.kde.org/documentation/library/kdeqt/kde3arch/xmlgui.html (Original)]
  * [[Development/Architecture/KDE4/KParts|KParts - perhaps the most important use case for advanced KXMLGUI stuff]]   * [[Development/Architecture/KDE4/KParts|KParts - perhaps the most important use case for advanced KXMLGUI stuff]]
  * [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/kpartgui.dtd?view=markup kpartgui / KXMLGUI document type definition]   * [http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/xmlgui/kpartgui.dtd?view=markup kpartgui / KXMLGUI document type definition]





Tfry: Add a todo link to mail by david faure
2009-09-18T14:08:36Z
Add a todo link to mail by david faure

				
				
				
				
			
			← Older revision
			Revision as of 14:08, 18 September 2009
			
Line 1:
Line 1:
− {{improve|This entire page needs a thorough review.}} + {{improve|This entire page needs a thorough review.
  +  
  + [[http://http://lists.kde.org/?l=kde-core-devel&m=124976855215580&w=2 These clarifications]], should be incorporated into this page, in particular regarding "append" in DefineGroup.}}
  {{Note|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry|Tfry]] 14:02, 22 May 2009 (UTC)}}   {{Note|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry|Tfry]] 14:02, 22 May 2009 (UTC)}}

← Older revision		Revision as of 14:08, 18 September 2009
Line 1:		Line 1:
−	{{improve\|This entire page needs a thorough review.}}	+	{{improve\|This entire page needs a thorough review.
		+
		+	[[http://http://lists.kde.org/?l=kde-core-devel&m=124976855215580&w=2 These clarifications]], should be incorporated into this page, in particular regarding "append" in DefineGroup.}}
	{{Note\|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry\|Tfry]] 14:02, 22 May 2009 (UTC)}}		{{Note\|I don't really feel overly qualified to write this page, but I've spent a whole lot of time figuring out some of the following things for lack of good documentation. So I'll make a start... --[[User:Tfry\|Tfry]] 14:02, 22 May 2009 (UTC)}}