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.
@short 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.
*/
public KXMLGUIClient(KXMLGUIClientInterface parent) {
newKXMLGUIClient(parent);
}
private native void newKXMLGUIClient(KXMLGUIClientInterface parent);
/**
Retrieves an action of the client by name. If not found, it looks in its child clients.
This method is provided for convenience, as it uses actionCollection()
to get the action object.
@short Retrieves an action of the client by name.
*/
public native TDEAction action(String name);
/**
Retrieves an action for a given TQDomElement. The default
implementation uses the "name" attribute to query the action
object via the other action() method.
@short Retrieves an action for a given TQDomElement.
*/
public native TDEAction action(TQDomElement element);
/**
Retrieves the entire action collection for the GUI client. If
you subclass KXMLGUIClient you should call
TDEActionCollection.setWidget( TQWidget ) with this object, or
you will encounter subtle bugs with TDEAction keyboard shortcuts.
This is not necessary if your KXMLGUIClient is a TDEMainWindow.
@short Retrieves the entire action collection for the GUI client.
@see TDEActionCollection#setWidget(
@see #org#kde#qt#TQWidget*
*/
public native TDEActionCollection actionCollection();
/**
@return The instance ( TDEInstance ) for this GUI client.
@short
*/
public native TDEInstanceInterface instance();
/**
@return The parsed XML in a TQDomDocument, set by
setXMLFile() or setXML().
This document describes the layout of the GUI.
@short
*/
public native TQDomDocument domDocument();
/**
This will return the name of the XML file as set by setXMLFile().
If setXML() is used directly, then this will return NULL.
The filename that this returns is obvious for components as each
component has exactly one XML file. In non-components, however,
there are usually two: the global file and the local file. This
function doesn't really care about that, though. It will always
return the last XML file set. This, in almost all cases, will
be the local XML file.
@return The name of the XML file or null
@short This will return the name of the XML file as set by setXMLFile().
*/
public native String xmlFile();
public native String localXMLFile();
/**
@short
*/
public native void setXMLGUIBuildDocument(TQDomDocument doc);
/**
@short
*/
public native TQDomDocument xmlguiBuildDocument();
/**
This method is called by the KXMLGUIFactory as soon as the client
is added to the KXMLGUIFactory's GUI.
@short This method is called by the KXMLGUIFactory as soon as the client is added to the KXMLGUIFactory's GUI.
*/
public native void setFactory(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.
@short 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.
*/
public native KXMLGUIFactory factory();
/**
KXMLGUIClients can form a simple child/parent object tree. This
method returns a pointer to the parent client or null if it has no
parent client assigned.
@short KXMLGUIClients can form a simple child/parent object tree.
*/
public native KXMLGUIClientInterface parentClient();
/**
Use this method to make a client a child client of another client.
Usually you don't need to call this method, as it is called
automatically when using the second constructor, which takes a
parent argument.
@short Use this method to make a client a child client of another client.
*/
public native void insertChildClient(KXMLGUIClientInterface child);
/**
Removes the given child
from the client's children list.
@short Removes the given child
from the client's children list.
*/
public native void removeChildClient(KXMLGUIClientInterface child);
/**
Retrieves a list of all child clients.
@short Retrieves a list of all child clients.
*/
// const TQPtrList\