|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kde.koala.KXMLGUIClient
public class KXMLGUIClient
A KXMLGUIClient can be used with KXMLGUIFactory to create a GUI from actions and an XML document, and can be dynamically merged with other KXMLGUIClients.
Field Summary | |
---|---|
static int |
StateNoReverse
|
static int |
StateReverse
|
Constructor Summary | |
---|---|
|
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. |
protected |
KXMLGUIClient(java.lang.Class dummy)
|
|
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(org.kde.qt.QDomElement element)
Retrieves an action for a given QDomElement. |
KAction |
action(java.lang.String name)
Retrieves an action of the client by name. |
KActionCollection |
actionCollection()
Retrieves the entire action collection for the GUI client. |
void |
addStateActionDisabled(java.lang.String state,
java.lang.String action)
|
void |
addStateActionEnabled(java.lang.String state,
java.lang.String action)
|
void |
beginXMLPlug(org.kde.qt.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() |
org.kde.qt.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 java.lang.String |
findMostRecentXMLFile(java.lang.String[] files,
java.lang.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? |
java.lang.String |
localXMLFile()
|
KXMLGUIClientInterface |
parentClient()
KXMLGUIClients can form a simple child/parent object tree. |
void |
prepareXMLUnplug(org.kde.qt.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(org.kde.qt.QDomDocument document)
|
protected void |
setDOMDocument(org.kde.qt.QDomDocument document,
boolean merge)
Sets the Document for the part, describing the layout of the GUI. |
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(java.lang.String file)
|
protected void |
setXML(java.lang.String document)
|
protected void |
setXML(java.lang.String document,
boolean merge)
Sets the XML for the part. |
protected void |
setXMLFile(java.lang.String file)
|
protected void |
setXMLFile(java.lang.String file,
boolean merge)
|
protected void |
setXMLFile(java.lang.String file,
boolean merge,
boolean setXMLDoc)
Sets the name of the rc file containing the XML for the part. |
void |
setXMLGUIBuildDocument(org.kde.qt.QDomDocument doc)
|
protected void |
stateChanged(java.lang.String newstate)
|
protected void |
stateChanged(java.lang.String newstate,
int reverse)
Actions can collectively be assigned a "State". |
void |
unplugActionList(java.lang.String name)
The complement of plugActionList() ... |
java.lang.String |
xmlFile()
This will return the name of the XML file as set by setXMLFile(). |
org.kde.qt.QDomDocument |
xmlguiBuildDocument()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int StateNoReverse
public static final int StateReverse
Constructor Detail |
---|
protected KXMLGUIClient(java.lang.Class dummy)
public KXMLGUIClient()
public KXMLGUIClient(KXMLGUIClientInterface parent)
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.
Method Detail |
---|
public KAction action(java.lang.String name)
action
in interface KXMLGUIClientInterface
public KAction action(org.kde.qt.QDomElement element)
action
in interface KXMLGUIClientInterface
public KActionCollection actionCollection()
actionCollection
in interface KXMLGUIClientInterface
KActionCollection#setWidget(
,
#org#kde#qt#QWidget*
public KInstanceInterface instance()
instance
in interface KXMLGUIClientInterface
public org.kde.qt.QDomDocument domDocument()
domDocument
in interface KXMLGUIClientInterface
public java.lang.String xmlFile()
xmlFile
in interface KXMLGUIClientInterface
public java.lang.String localXMLFile()
localXMLFile
in interface KXMLGUIClientInterface
public void setXMLGUIBuildDocument(org.kde.qt.QDomDocument doc)
setXMLGUIBuildDocument
in interface KXMLGUIClientInterface
public org.kde.qt.QDomDocument xmlguiBuildDocument()
xmlguiBuildDocument
in interface KXMLGUIClientInterface
public void setFactory(KXMLGUIFactory factory)
setFactory
in interface KXMLGUIClientInterface
public KXMLGUIFactory factory()
factory
in interface KXMLGUIClientInterface
public KXMLGUIClientInterface parentClient()
parentClient
in interface KXMLGUIClientInterface
public void insertChildClient(KXMLGUIClientInterface child)
insertChildClient
in interface KXMLGUIClientInterface
public void removeChildClient(KXMLGUIClientInterface child)
child
from the client's children list.
removeChildClient
in interface KXMLGUIClientInterface
public void setClientBuilder(KXMLGUIBuilderInterface builder)
setClientBuilder
in interface KXMLGUIClientInterface
public KXMLGUIBuilderInterface clientBuilder()
clientBuilder
in interface KXMLGUIClientInterface
public void reloadXML()
reloadXML
in interface KXMLGUIClientInterface
public void unplugActionList(java.lang.String name)
unplugActionList
in interface KXMLGUIClientInterface
public void addStateActionEnabled(java.lang.String state, java.lang.String action)
addStateActionEnabled
in interface KXMLGUIClientInterface
public void addStateActionDisabled(java.lang.String state, java.lang.String action)
addStateActionDisabled
in interface KXMLGUIClientInterface
public void beginXMLPlug(org.kde.qt.QWidget arg1)
beginXMLPlug
in interface KXMLGUIClientInterface
public void endXMLPlug()
endXMLPlug
in interface KXMLGUIClientInterface
public void prepareXMLUnplug(org.kde.qt.QWidget arg1)
prepareXMLUnplug
in interface KXMLGUIClientInterface
public static java.lang.String findMostRecentXMLFile(java.lang.String[] files, java.lang.StringBuffer doc)
protected void setInstance(KInstanceInterface instance)
protected void setXMLFile(java.lang.String file, boolean merge, boolean setXMLDoc)
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.protected void setXMLFile(java.lang.String file, boolean merge)
protected void setXMLFile(java.lang.String file)
protected void setLocalXMLFile(java.lang.String file)
protected void setXML(java.lang.String document, boolean merge)
protected void setXML(java.lang.String document)
protected void setDOMDocument(org.kde.qt.QDomDocument document, boolean merge)
protected void setDOMDocument(org.kde.qt.QDomDocument document)
protected void conserveMemory()
protected void stateChanged(java.lang.String newstate, int reverse)
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.protected void stateChanged(java.lang.String newstate)
protected void finalize() throws java.lang.InternalError
finalize
in class java.lang.Object
java.lang.InternalError
public void dispose()
public boolean isDisposed()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |