KXMLGUIFactory Class Reference

from PyKDE4.kdeui import *

Detailed Description

Signals
	clientAdded (KXMLGUIClient client)
	clientRemoved (KXMLGUIClient client)
Methods
	__init__ (self, KXMLGUIBuilder builder, QObject parent=0)
	addClient (self, KXMLGUIClient client)
	clientAdded (self, KXMLGUIClient client)
	clientRemoved (self, KXMLGUIClient client)
[KXMLGUIClien]	clients (self)
int	configureShortcuts (self, bool bAllowLetterShortcuts=1, bool bSaveSettings=1)
QWidget	container (self, QString containerName, KXMLGUIClient client, bool useTagName=0)
[QWidge]	containers (self, QString tagName)
	plugActionList (self, KXMLGUIClient client, QString name, [QActio] actionList)
	removeClient (self, KXMLGUIClient client)
	reset (self)
	resetContainer (self, QString containerName, bool useTagName=0)
	unplugActionList (self, KXMLGUIClient client, QString name)
Static Methods
QDomElement	actionPropertiesElement (QDomDocument doc)
QDomElement	findActionByName (QDomElement elem, QString sName, bool create)
QString	readConfigFile (QString filename, KComponentData componentData=KComponentData())
bool	saveConfigFile (QDomDocument doc, QString filename, KComponentData componentData=KComponentData())

Method Documentation

__init__	(	self,
		KXMLGUIBuilder	builder,
		QObject	parent=0
	)

Constructs a KXMLGUIFactory. The provided builder KXMLGUIBuilder will be called for creating and removing container widgets, when clients are added/removed from the GUI.

Note that the ownership of the given KXMLGUIBuilder object won't be transferred to this KXMLGUIFactory, so you have to take care of deleting it properly.

QDomElement actionPropertiesElement	(	QDomDocument	doc
	)

Internal:: Find or create the ActionProperties element, used when saving custom action properties

addClient	(	self,
		KXMLGUIClient	client
	)

Creates the GUI described by the QDomDocument of the client, using the client's actions, and merges it with the previously created GUI. This also means that the order in which clients are added to the factory is relevant; assuming that your application supports plugins, you should first add your application to the factory and then the plugin, so that the plugin's UI is merged into the UI of your application, and not the other way round.

clientAdded	(	self,
		KXMLGUIClient	client
	)

Signal syntax:: QObject.connect(source, SIGNAL("clientAdded(KXMLGUIClient*)"), target_slot)

clientRemoved	(	self,
		KXMLGUIClient	client
	)

Signal syntax:: QObject.connect(source, SIGNAL("clientRemoved(KXMLGUIClient*)"), target_slot)

[KXMLGUIClien] clients ( self )

Returns a list of all clients currently added to this factory

int configureShortcuts	(	self,
		bool	bAllowLetterShortcuts=1,
		bool	bSaveSettings=1
	)

Show a standard configure shortcut for every action in this factory.

This slot can be connected directly to the action to configure shortcuts. This is very simple to do that by adding a single line

 KStandardAction.keyBindings( guiFactory(), SLOT( configureShortcuts() ), actionCollection() );

Parameters:

	bAllowLetterShortcuts	Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.
	bSaveSettings	if true, the settings will also be saved back to the *uirc file which they were intially read from.

QWidget container	(	self,
		QString	containerName,
		KXMLGUIClient	client,
		bool	useTagName=0
	)

Use this method to get access to a container widget with the name specified with containerName and which is owned by the client. The container name is specified with a "name" attribute in the XML document.

This function is particularly useful for getting hold of a popupmenu defined in an XMLUI file. For instance:

 QMenu *popup = static_cast<QMenu*>(guiFactory()->container("my_popup",this));

where "my_popup" is the name of the menu in the XMLUI file, and "this" is XMLGUIClient which owns the popupmenu (e.g. the mainwindow, or the part, or the plugin...)

Parameters:

	containerName	Name of the container widget
	client	Owner of the container widget
	useTagName	Specifies whether to compare the specified name with the name attribute or the tag name.

This method may return 0 if no container with the given name exists or is not owned by the client.

[QWidge] containers	(	self,
		QString	tagName
	)

QDomElement findActionByName	(	QDomElement	elem,
		QString	sName,
		bool	create
	)

Internal:: Find or create the element for a given action, by name. Used when saving custom action properties

plugActionList	(	self,
		KXMLGUIClient	client,
		QString	name,
		[QActio]	actionList
	)

QString readConfigFile	(	QString	filename,
		KComponentData	componentData=KComponentData()
	)

Internal:

removeClient	(	self,
		KXMLGUIClient	client
	)

Removes the GUI described by the client, by unplugging all provided actions and removing all owned containers (and storing container state information in the given client)

reset ( self )

Use this method to free all memory allocated by the KXMLGUIFactory. This deletes the internal node tree and therefore resets the internal state of the class. Please note that the actual GUI is NOT touched at all, meaning no containers are deleted nor any actions unplugged. That is something you have to do on your own. So use this method only if you know what you are doing :-)

(also note that this will call KXMLGUIClient.setFactory( 0 ) for all inserted clients)

resetContainer	(	self,
		QString	containerName,
		bool	useTagName=0
	)

Use this method to free all memory allocated by the KXMLGUIFactory for a specific container, including all child containers and actions. This deletes the internal node subtree for the specified container. The actual GUI is not touched, no containers are deleted or any actions unplugged. Use this method only if you know what you are doing :-)

(also note that this will call KXMLGUIClient.setFactory( 0 ) for all clients of the container)

bool saveConfigFile	(	QDomDocument	doc,
		QString	filename,
		KComponentData	componentData=KComponentData()
	)

Internal:

unplugActionList	(	self,
		KXMLGUIClient	client,
		QString	name
	)

KXMLGUIFactory Class Reference

Detailed Description

Signals

Methods

Static Methods

Method Documentation

Modules