org.kde.koala
public class KXMLGUIClient extends Object implements QtSupport, KXMLGUIClientInterface
UNKNOWN:
Field Summary | |
---|---|
static int | StateNoReverse |
static int | StateReverse |
Constructor Summary | |
---|---|
protected | KXMLGUIClient(Class dummy) |
KXMLGUIClient()
Constructs a KXMLGUIClient which can be used with a
KXMLGUIFactory to create a GUI from actions and an XML document, and
which can be dynamically merged with other KXMLGUIClients. | |
KXMLGUIClient(KXMLGUIClientInterface parent)
Constructs a KXMLGUIClient which can be used with a KXMLGUIFactory
to create a GUI from actions and an XML document,
and which can be dynamically merged with other KXMLGUIClients.
|
Method Summary | |
---|---|
KAction | action(String name)
Retrieves an action of the client by name. |
KAction | action(QDomElement element)
Retrieves an action for a given QDomElement. |
KActionCollection | actionCollection()
Retrieves the entire action collection for the GUI client. |
void | addStateActionDisabled(String state, String action) |
void | addStateActionEnabled(String state, String action) |
void | beginXMLPlug(QWidget arg1) |
KXMLGUIBuilderInterface | clientBuilder()
Retrieves the client's GUI builder or null if no client specific
builder has been assigned via setClientBuilder() |
protected void | conserveMemory()
This function will attempt to give up some memory after the GUI
is built. |
void | dispose() Delete the wrapped C++ instance ahead of finalize() |
QDomDocument | domDocument() |
void | endXMLPlug() |
KXMLGUIFactory | factory()
Retrieves a pointer to the KXMLGUIFactory this client is
associated with (will return null if the client's GUI has not been built
by a KXMLGUIFactory. |
protected void | finalize() Deletes the wrapped C++ instance |
static String | findMostRecentXMLFile(String[] files, StringBuffer doc) |
void | insertChildClient(KXMLGUIClientInterface child)
Use this method to make a client a child client of another client.
|
KInstanceInterface | instance() |
boolean | isDisposed() Has the wrapped C++ instance been deleted? |
String | localXMLFile() |
KXMLGUIClientInterface | parentClient()
KXMLGUIClients can form a simple child/parent object tree. |
void | prepareXMLUnplug(QWidget arg1) |
void | reloadXML()
Forces this client to re-read its XML resource file. |
void | removeChildClient(KXMLGUIClientInterface child)
Removes the given child from the client's children list. |
void | setClientBuilder(KXMLGUIBuilderInterface builder)
A client can have an own KXMLGUIBuilder.
|
protected void | setDOMDocument(QDomDocument document, boolean merge)
Sets the Document for the part, describing the layout of the GUI.
|
protected void | setDOMDocument(QDomDocument document) |
void | setFactory(KXMLGUIFactory factory)
This method is called by the KXMLGUIFactory as soon as the client
is added to the KXMLGUIFactory's GUI. |
protected void | setInstance(KInstanceInterface instance)
Sets the instance ( KInstance) for this part.
|
protected void | setLocalXMLFile(String file) |
protected void | setXML(String document, boolean merge)
Sets the XML for the part.
|
protected void | setXML(String document) |
protected void | setXMLFile(String file, boolean merge, boolean setXMLDoc)
Sets the name of the rc file containing the XML for the part.
|
protected void | setXMLFile(String file, boolean merge) |
protected void | setXMLFile(String file) |
void | setXMLGUIBuildDocument(QDomDocument doc) |
protected void | stateChanged(String newstate, int reverse)
Actions can collectively be assigned a "State". |
protected void | stateChanged(String newstate) |
void | unplugActionList(String name)
The complement of plugActionList() ... |
String | xmlFile()
This will return the name of the XML file as set by setXMLFile().
|
QDomDocument | xmlguiBuildDocument() |
UNKNOWN: Constructs a KXMLGUIClient which can be used with a KXMLGUIFactory to create a GUI from actions and an XML document, and which can be dynamically merged with other KXMLGUIClients.
parent
argument, which makes
the client a child client of the parent.
Child clients are automatically added to the GUI if the parent is added.UNKNOWN: Constructs a KXMLGUIClient which can be used with a KXMLGUIFactory to create a GUI from actions and an XML document, and which can be dynamically merged with other KXMLGUIClients.
UNKNOWN: Retrieves an action of the client by name.
UNKNOWN: Retrieves an action for a given QDomElement.
See Also: (
#kde#qt#QWidget*
UNKNOWN: Retrieves the entire action collection for the GUI client.
UNKNOWN: Retrieves the client's GUI builder or 0L if no client specific builder has been assigned via setClientBuilder()
UNKNOWN: This function will attempt to give up some memory after the GUI is built.
Returns: The parsed XML in a QDomDocument, set by setXMLFile() or setXML(). This document describes the layout of the GUI.
UNKNOWN:
UNKNOWN: Retrieves a pointer to the KXMLGUIFactory this client is associated with (will return 0L if the client's GUI has not been built by a KXMLGUIFactory.
UNKNOWN: Use this method to make a client a child client of another client.
Returns: The instance ( KInstance ) for this GUI client.
UNKNOWN:
UNKNOWN: KXMLGUIClients can form a simple child/parent object tree.
UNKNOWN: Forces this client to re-read its XML resource file.
child
from the client's children list.UNKNOWN: Removes the given child
from the client's children list.
UNKNOWN: A client can have an own KXMLGUIBuilder.
UNKNOWN: Sets the Document for the part, describing the layout of the GUI.
UNKNOWN: This method is called by the KXMLGUIFactory as soon as the client is added to the KXMLGUIFactory's GUI.
UNKNOWN: Sets the instance ( KInstance) for this part.
UNKNOWN: Sets the XML for the part.
Parameters: file Either an absolute path for the file, or simply the filename, which will then be assumed to be installed in the "data" resource, under a directory named like the instance. merge Whether to merge with the global document. setXMLDoc Specify whether to call setXML. Default is true. and the DOM document at once.
UNKNOWN: Sets the name of the rc file containing the XML for the part.
UNKNOWN:
Parameters: newstate Name of a State in the XMLfile. reverse If the flag reverse is set to StateReverse, the State is reversed. (actions to be enabled will be disabled and action to be disabled will be enabled) Default is reverse=false.
UNKNOWN: Actions can collectively be assigned a "State".
UNKNOWN: The complement of plugActionList() .
Returns: The name of the XML file or null
UNKNOWN: This will return the name of the XML file as set by setXMLFile().
UNKNOWN: