Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KXMLGUIClient Class Reference

#include <kxmlguiclient.h>

Inheritance diagram for KXMLGUIClient:

KDEPrivate::ToolBarHandler KEditToolbarWidget KMainWindow KParts::PartBase KParts::Plugin KTextEditor::View KDockMainWindow KParts::MainWindow KParts::DockMainWindow KParts::MainWindow KParts::Part KParts::DockMainWindow KParts::ReadOnlyPart KMediaPlayer::Player KParts::ReadWritePart KTextEditor::Editor List of all members.

Public Methods

 KXMLGUIClient ()
 KXMLGUIClient (KXMLGUIClient *parent)
virtual ~KXMLGUIClient ()
KAction * action (const char *name) const
virtual KAction * action (const QDomElement &element) const
virtual KActionCollection * actionCollection () const
virtual KInstance * instance () const
virtual QDomDocument domDocument () const
virtual QString xmlFile () const
void setFactory (KXMLGUIFactory *factory)
KXMLGUIFactory * factory () const
KXMLGUIClient * parentClient () const
void insertChildClient (KXMLGUIClient *child)
void removeChildClient (KXMLGUIClient *child)
const QPtrList< KXMLGUIClient > * childClients ()
void setClientBuilder (KXMLGUIBuilder *builder)
KXMLGUIBuilder * clientBuilder () const
void reloadXML ()
void plugActionList (const QString &name, const QPtrList< KAction > &actionList)
void unplugActionList (const QString &name)
void beginXMLPlug (QWidget *)
 
Since:
3.1


void endXMLPlug ()
 
Since:
3.1


void prepareXMLUnplug (QWidget *)
 
Since:
3.1



Protected Methods

virtual void setInstance (KInstance *instance)
virtual void setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void setXML (const QString &document, bool merge=false)
virtual void setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void conserveMemory ()
virtual void stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)

Detailed Description

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.

Definition at line 41 of file kxmlguiclient.h.

Constructor & Destructor Documentation

KXMLGUIClient::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::KXMLGUIClient (  KXMLGUIClient *    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.

This constructor takes an additional 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.

virtual KXMLGUIClient::~KXMLGUIClient (    )  [virtual]
 

Destructs the KXMLGUIClient.

Member Function Documentation

virtual KAction* KXMLGUIClient::action (  const QDomElement &    element )  const [virtual]
 

Retrieves an action for a given QDomElement. The default implementation uses the "name" attribute to query the action object via the other action() method.

KAction* KXMLGUIClient::action (  const char *    name )  const
 

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.

virtual KActionCollection* KXMLGUIClient::actionCollection (    )  [virtual]
 

Retrieves the entire action collection for the GUI client

Reimplemented in KEditToolbarWidget.

const QPtrList<KXMLGUIClient>* KXMLGUIClient::childClients (    ) 
 

Retrieves a list of all child clients.

KXMLGUIBuilder* KXMLGUIClient::clientBuilder (    ) 
 

Retrieves the client's GUI builder or 0L if no client specific builder has been assigned via setClientBuilder()

virtual void KXMLGUIClient::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).

virtual QDomDocument KXMLGUIClient::domDocument (    )  [virtual]
 

Returns:
The parsed XML in a QDomDocument, set by setXMLFile() or setXML(). This document describes the layout of the GUI.

KXMLGUIFactory* KXMLGUIClient::factory (    ) 
 

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.

void KXMLGUIClient::insertChildClient (  KXMLGUIClient *    child ) 
 

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 arent argument.

virtual KInstance* KXMLGUIClient::instance (    )  [virtual]
 

Returns:
The instance (KInstance) for this part.

KXMLGUIClient* KXMLGUIClient::parentClient (    ) 
 

KXMLGUIClients can form a simple child/parent object tree. This method returns a pointer to the parent client or 0L if it has no parent client assigned.

void KXMLGUIClient::plugActionList (  const QString &    name,
const QPtrList< KAction > &    actionList
) 
 

ActionLists are a way for XMLGUI to support dynamic lists of actions. E.g. if you are writing a file manager, and there is a menu file whose contents depend on the mimetype of the file that is selected, then you can achieve this using ActionLists. It works as follows: In your xxxui.rc file ( the one that you set in setXMLFile() ), you put an <ActionList name="xxx"> tag. E.g. 

   * <kpartgui name="xxx_part" version="1">
   * <MenuBar>
   *   <Menu name="file">
   *     ...  <!-- some useful actions-->
   *     <ActionList name="xxx_file_actionlist" />
   *     ...  <!-- even more useful actions-->
   *   </Menu>
   *   ...
   * </MenuBar>
   * </kpartgui>
   *

This tag will get expanded to a list of actions. In the example above ( a file manager with a dynamic file menu ), you would call 

 QPtrList<KAction> file_actions;
 for( ... )
   if( ... )
     file_actions.append( cool_action );
 unplugActionList( "xxx_file_actionlist" );
 plugActionList( "xxx_file_actionlist", file_actions );
every time a file is selected, unselected or ...

Note:
You should not call createGUI() after calling this function. In fact, that would remove the newly added actionlists again...
Forgetting to call unplugActionList() before plugActionList() would leave the previous actions in the menu too..

void KXMLGUIClient::reloadXML (    ) 
 

Forces this client to re-read its XML resource file. This is intended to be used when you know that the resource file has changed and you will soon be rebuilding the GUI. It has no useful effect with non-KParts GUIs, so don't bother using it unless your app is component based.

void KXMLGUIClient::removeChildClient (  KXMLGUIClient *    child ) 
 

Removes the given child from the client's children list.

void KXMLGUIClient::setClientBuilder (  KXMLGUIBuilder *    builder ) 
 

A client can have an own KXMLGUIBuilder. Use this method to assign your builder instance to the client (so that the KXMLGUIFactory can use it when building the client's GUI)

Client specific guibuilders are useful if you want to create custom container widgets for your GUI.

virtual void KXMLGUIClient::setDOMDocument (  const QDomDocument &    document,
bool    merge = false
)  [protected, virtual]
 

Sets the Document for the part, describing the layout of the GUI.

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

void KXMLGUIClient::setFactory (  KXMLGUIFactory *    factory ) 
 

This method is called by the KXMLGUIFactory as soon as the client is added to the KXMLGUIFactory's GUI.

virtual void KXMLGUIClient::setInstance (  KInstance *    instance )  [protected, virtual]
 

Sets the instance (KInstance) for this part.

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

Reimplemented in KParts::PartBase, and KParts::Plugin.

virtual void KXMLGUIClient::setXML (  const QString &    document,
bool    merge = false
)  [protected, virtual]
 

Sets the XML for the part.

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

virtual void KXMLGUIClient::setXMLFile (  const QString &    file,
bool    merge = false,
bool    setXMLDoc = true
)  [protected, virtual]
 

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

Call this in the Part-inherited class constructor.

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.
setXML  Specify whether to call setXML. Default is true. and the DOM document at once.

virtual void KXMLGUIClient::stateChanged (  const QString &    newstate,
ReverseStateChange    reverse = StateNoReverse
)  [protected, virtual]
 

Actions can collectively be assigned a "State". To accomplish this the respective actions are tagged as <enable> or <disable> in a <State> </State> group of the XMLfile. During program execution the programmer can call stateChanged() to set actions to a defined state.

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.

void KXMLGUIClient::unplugActionList (  const QString &    name ) 
 

The complement of plugActionList() ...

virtual QString KXMLGUIClient::xmlFile (    )  [virtual]
 

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.

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

Reimplemented in KParts::Plugin.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:29 2003 for kdelibs by doxygen1.2.18