diff options
Diffstat (limited to 'kdejava/koala/org/kde/koala/KXMLGUIClient.java')
| -rw-r--r-- | kdejava/koala/org/kde/koala/KXMLGUIClient.java | 290 |
1 files changed, 0 insertions, 290 deletions
diff --git a/kdejava/koala/org/kde/koala/KXMLGUIClient.java b/kdejava/koala/org/kde/koala/KXMLGUIClient.java deleted file mode 100644 index 346f9081..00000000 --- a/kdejava/koala/org/kde/koala/KXMLGUIClient.java +++ /dev/null @@ -1,290 +0,0 @@ -//Auto-generated by kalyptus. DO NOT EDIT. -package org.kde.koala; - -import org.kde.qt.Qt; -import org.kde.qt.TQDomDocument; -import org.kde.qt.QtSupport; -import org.kde.qt.TQWidget; -import org.kde.qt.TQDomElement; - -/** - - 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. - @short - -*/ -public class KXMLGUIClient implements QtSupport, KXMLGUIClientInterface { - private long _qt; - private boolean _allocatedInJavaWorld = true; - protected KXMLGUIClient(Class dummy){} - - public static final int StateNoReverse = 0; - public static final int StateReverse = 1; - - /** - 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. - @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() { - newKXMLGUIClient(); - } - private native void newKXMLGUIClient(); - /** - 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 <code>parent</code> 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 <code>child</code> from the client's children list. - @short Removes the given <code>child</code> 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<KXMLGUIClient>* childClients(); >>>> NOT CONVERTED - /** - 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. - @short A client can have an own KXMLGUIBuilder. - */ - public native void setClientBuilder(KXMLGUIBuilderInterface builder); - /** - Retrieves the client's GUI builder or null if no client specific - builder has been assigned via setClientBuilder() - @short Retrieves the client's GUI builder or 0L if no client specific builder has been assigned via setClientBuilder() - */ - public native KXMLGUIBuilderInterface clientBuilder(); - /** - 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. - @short Forces this client to re-read its XML resource file. - */ - public native void reloadXML(); - /** - 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 <p>\<ActionList name="xxx"\></p> tag. E.g. - <pre> - <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> - </pre> - 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 - <pre> - TQPtrList<TDEAction> file_actions; - for( ... ) - if( ... ) - file_actions.append( cool_action ); - unplugActionList( "xxx_file_actionlist" ); - plugActionList( "xxx_file_actionlist", file_actions ); - </pre> - every time a file is selected, unselected or ... - <b>Note:<> You should not call createGUI() after calling this - function. In fact, that would remove the newly added - actionlists again... - <b>Note:<> Forgetting to call unplugActionList() before - plugActionList() would leave the previous actions in the - menu too.. - @short ActionLists are a way for XMLGUI to support dynamic lists of actions. - */ - // void plugActionList(const TQString& arg1,const TQPtrList<TDEAction>& arg2); >>>> NOT CONVERTED - /** - The complement of plugActionList() ... - @short The complement of plugActionList() . - */ - public native void unplugActionList(String name); - public native void addStateActionEnabled(String state, String action); - public native void addStateActionDisabled(String state, String action); - // KXMLGUIClient::StateChange getActionsToChangeForState(const TQString& arg1); >>>> NOT CONVERTED - public native void beginXMLPlug(TQWidget arg1); - public native void endXMLPlug(); - public native void prepareXMLUnplug(TQWidget arg1); - public static native String findMostRecentXMLFile(String[] files, StringBuffer doc); - /** - Sets the instance ( TDEInstance) for this part. - Call this first in the inherited class constructor. - (At least before setXMLFile().) - @short Sets the instance ( TDEInstance) for this part. - */ - protected native void setInstance(TDEInstanceInterface instance); - /** - Sets the name of the rc file containing the XML for the part. - Call this in the Part-inherited class constructor. - @param 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. - @param merge Whether to merge with the global document. - @param setXMLDoc Specify whether to call setXML. Default is true. - and the DOM document at once. - @short Sets the name of the rc file containing the XML for the part. - */ - protected native void setXMLFile(String file, boolean merge, boolean setXMLDoc); - protected native void setXMLFile(String file, boolean merge); - protected native void setXMLFile(String file); - protected native void setLocalXMLFile(String file); - /** - Sets the XML for the part. - Call this in the Part-inherited class constructor if you - don't call setXMLFile(). - @short Sets the XML for the part. - */ - protected native void setXML(String document, boolean merge); - protected native void setXML(String document); - /** - 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 . - @short Sets the Document for the part, describing the layout of the GUI. - */ - protected native void setDOMDocument(TQDomDocument document, boolean merge); - protected native void setDOMDocument(TQDomDocument document); - /** - 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). - @short This function will attempt to give up some memory after the GUI is built. - */ - protected native void conserveMemory(); - /** - 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. - @param newstate Name of a State in the XMLfile. - @param 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. - @short Actions can collectively be assigned a "State". - */ - protected native void stateChanged(String newstate, int reverse); - protected native void stateChanged(String newstate); - /** Deletes the wrapped C++ instance */ - protected native void finalize() throws InternalError; - /** Delete the wrapped C++ instance ahead of finalize() */ - public native void dispose(); - /** Has the wrapped C++ instance been deleted? */ - public native boolean isDisposed(); -} |