class KXMLGUIClient


Definition#include <kxmlguiclient.h>
Inherited byKDockMainWindow, KEditToolbarWidget, KTMainWindow, KTopLevelWidget
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

KInstanceinstance ()

[const virtual]

Returns: The instance (KInstance) for this part.

QDomDocument  document ()

[const virtual]

Returns: The parsed XML in a QDomDocument, set by setXMLFile() or setXML()

QString  xmlFile ()

[const virtual]

This will return 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.

Returns: The name of the XML file or QString::null

void  storeContainerStateBuffer ( const QString &key, const QByteArray &data )

[virtual]

default implementation, storing the given data in an internal map. Called from KKXMLGUIFactory when removing containers which were owned by the servant.

QByteArray  takeContainerStateBuffer ( const QString &key )

[virtual]

default implementation, returning a previously via storeContainerStateBuffer saved data. Called from KKXMLGUIFactory when creating a new container.

void  setContainerStates ( const QMap<QString,QByteArray> &states )

<<INTERNAL>>

QMap<QString,QByteArray>  containerStates ()

[const]

<<INTERNAL>>

void  setInstance ( KInstance *instance )

[protected virtual]

Set the instance (KInstance) for this part.

Call this first in the inherited class constructor. (At least before setXMLFile().)

void  setXMLFile ( const QString& file, bool merge = false )

[protected virtual]

Set the name of the rc file containing the XML for the part.

Call this in the Part-inherited class constructor.

Parameters:
fileEither 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.

void  setXML ( const QString &document, bool merge = false )

[protected virtual]

Set the XML for the part.

Call this in the Part-inherited class constructor if you don't call setXMLFile().

void  conserveMemory ()

[protected virtual]

This function will attempt to give up some memory after the GUI is built. It should never be used in apps where the GUI may be rebuilt at some later time (components, for instance).


Generated by: dfaure@faure on Sun Mar 26 14:24:24 2000, using kdoc 2.0a35.