org.kde.koala
public class KEditToolbarWidget extends QWidget implements KXMLGUIClientInterface
Version: $Id: KEditToolbarWidget.java 473384 2005-10-23 14:17:09Z rdale $
UNKNOWN: A widget used to customize or configure toolbars.
Constructor Summary | |
---|---|
protected | KEditToolbarWidget(Class dummy) |
KEditToolbarWidget(KActionCollection collection, String xmlfile, boolean global, QWidget parent)
Constructor. | |
KEditToolbarWidget(KActionCollection collection, String xmlfile, boolean global) | |
KEditToolbarWidget(KActionCollection collection, String xmlfile) | |
KEditToolbarWidget(KActionCollection collection) | |
KEditToolbarWidget(String defaultToolbar, KActionCollection collection, String file, boolean global, QWidget parent) | |
KEditToolbarWidget(String defaultToolbar, KActionCollection collection, String file, boolean global) | |
KEditToolbarWidget(String defaultToolbar, KActionCollection collection, String file) | |
KEditToolbarWidget(String defaultToolbar, KActionCollection collection) | |
KEditToolbarWidget(KXMLGUIFactory factory, QWidget parent)
Constructor for KParts based apps.
| |
KEditToolbarWidget(KXMLGUIFactory factory) | |
KEditToolbarWidget(String defaultToolbar, KXMLGUIFactory factory, QWidget parent) | |
KEditToolbarWidget(String defaultToolbar, KXMLGUIFactory factory) |
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() |
void | addStateActionDisabled(String state, String action) |
void | addStateActionEnabled(String state, String action) |
void | beginXMLPlug(QWidget arg1) |
String | className() |
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) |
protected void | initKPart(KXMLGUIFactory factory) |
protected void | initNonKPart(KActionCollection collection, String file, boolean global) |
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? |
protected void | loadActionList(QDomElement elem) |
protected void | loadToolbarCombo(String defaultToolbar) |
protected void | loadToolbarCombo() |
String | localXMLFile() |
QMetaObject | metaObject() |
KXMLGUIClientInterface | parentClient()
KXMLGUIClients can form a simple child/parent object tree. |
void | prepareXMLUnplug(QWidget arg1) |
void | rebuildKXMLGUIClients()
Remove and readd all KMXLGUIClients to update the GUI |
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. |
boolean | save()
Save any changes the user made. |
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 | setupLayout() |
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 | slotActiveSelected(QListViewItem item) |
protected void | slotChangeIcon() |
protected void | slotDownButton() |
protected void | slotDropped(KListView list, QDropEvent e, QListViewItem after) |
protected void | slotInactiveSelected(QListViewItem item) |
protected void | slotInsertButton() |
protected void | slotRemoveButton() |
protected void | slotToolbarSelected(String text) |
protected void | slotUpButton() |
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() ... |
protected void | updateLocal(QDomElement elem) |
String | xmlFile()
This will return the name of the XML file as set by setXMLFile().
|
QDomDocument | xmlguiBuildDocument() |
must
pass along your collection of actions (some of which
appear in your toolbars). The other three parameters are
optional.
The second parameter, xmlfile, is the name (absolute or
relative) of your application's UI resource file. If it is
left blank, then the resource file: share/apps/appname/appnameui.rc
is used. This is the same resource file that is used by the
default createGUI function in KMainWindow so you're usually
pretty safe in leaving it blank.
The third parameter, global, controls whether or not the
global resource file is used. If this is true, then you may
edit all of the actions in your toolbars -- global ones and
local one. If it is false, then you may edit only your
application's entries. The only time you should set this to
false is if your application does not use the global resource
file at all (very rare)
The last parameter, parent, is the standard parent stuff.Parameters: collection The collection of actions to work on xmlfile The application's local resource file global If true, then the global resource file will also be parsed parent This widget's parent
UNKNOWN: Constructor.
KEditToolbar edit(factory()); if ( edit.exec() ) ...
Parameters: factory Your application's factory object parent This widget's parent
UNKNOWN: Constructor for KParts based apps.
UNKNOWN: Retrieves an action of the client by name.
UNKNOWN: Retrieves an action for a given QDomElement.
UNKNOWN:
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: Remove and readd all KMXLGUIClients to update the GUI
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.
Returns: The status of whether or not the save succeeded.
UNKNOWN: Save any changes the user made.
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: