TDEMainWindow kmw = new TDEMainWindow (...);@short Construct a main window. @see #http://doc#trolltech#com/3#2/qt#html#WidgetFlags-enum */ public TDEMainWindow(TQWidget parent, String name, int f) { super((Class) null); newTDEMainWindow(parent,name,f); } private native void newTDEMainWindow(TQWidget parent, String name, int f); public TDEMainWindow(TQWidget parent, String name) { super((Class) null); newTDEMainWindow(parent,name); } private native void newTDEMainWindow(TQWidget parent, String name); public TDEMainWindow(TQWidget parent) { super((Class) null); newTDEMainWindow(parent); } private native void newTDEMainWindow(TQWidget parent); public TDEMainWindow() { super((Class) null); newTDEMainWindow(); } private native void newTDEMainWindow(); /** Overloaded constructor which allows passing some TDEMainWindow.CreationFlags. @short Overloaded constructor which allows passing some TDEMainWindow.CreationFlags. */ public TDEMainWindow(int cflags, TQWidget parent, String name, int f) { super((Class) null); newTDEMainWindow(cflags,parent,name,f); } private native void newTDEMainWindow(int cflags, TQWidget parent, String name, int f); public TDEMainWindow(int cflags, TQWidget parent, String name) { super((Class) null); newTDEMainWindow(cflags,parent,name); } private native void newTDEMainWindow(int cflags, TQWidget parent, String name); public TDEMainWindow(int cflags, TQWidget parent) { super((Class) null); newTDEMainWindow(cflags,parent); } private native void newTDEMainWindow(int cflags, TQWidget parent); public TDEMainWindow(int cflags) { super((Class) null); newTDEMainWindow(cflags); } private native void newTDEMainWindow(int cflags); /** Retrieve the standard help menu. It contains entires for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box. Example (adding a standard help menu to your application):
TDEPopupMenu help = helpMenu(@param aboutAppText The string that is used in the application specific dialog box. If you leave this string empty the information in the global TDEAboutData of the application will be used to make a standard dialog box. @param showWhatsThis Set this to false if you do not want to include the "What's This" menu entry. @return A standard help menu. @short Retrieve the standard help menu. */ public native TDEPopupMenu helpMenu(String aboutAppText, boolean showWhatsThis); public native TDEPopupMenu helpMenu(String aboutAppText); public native TDEPopupMenu helpMenu(); /** Returns the help menu. Creates a standard help menu if none exists yet. It contains entries for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box. You must create the application specific dialog box yourself. When the "About application" menu entry is activated, a signal will trigger the showAboutApplication slot. See showAboutApplication for more information. Example (adding a help menu to your application):); menuBar().insertItem( i18n("&Help"), help );
menuBar().insertItem( i18n("&Help"), customHelpMenu() );
@param showWhatsThis Set this to false if you do not want to include
the "What's This" menu entry.
@return A standard help menu.
@short Returns the help menu.
*/
public native TDEPopupMenu customHelpMenu(boolean showWhatsThis);
public native TDEPopupMenu customHelpMenu();
/**
Reimplementation of TQMainWindow.show()
@short Reimplementation of TQMainWindow.show()
*/
public native void show();
/**
Reimplementation of TQMainWindow.hide()
@short Reimplementation of TQMainWindow.hide()
*/
public native void hide();
/**
Restore the session specified by number.
Returns false if this
fails, otherwise returns true and shows the window.
You should call canBeRestored() first.
If show is true (default), this widget will be shown automatically.
@short Restore the session specified by number.
*/
public native boolean restore(int number, boolean show);
public native boolean restore(int number);
public native KXMLGUIFactory guiFactory();
/**
Create a GUI given a local XML file.
If xmlfile is NULL,
then it will try to construct a local XML filename like
appnameui.rc where 'appname' is your app's name. If that file
does not exist, then the XML UI code will only use the global
(standard) XML file for the layout purposes.
Note that when passing true for the conserveMemory argument subsequent
calls to guiFactory().addClient/removeClient may not work as expected.
Also retrieving references to containers like popup menus or toolbars using
the container method will not work.
@param xmlfile The local xmlfile (relative or absolute)
@param _conserveMemory Specify whether createGUI() should call
KXMLGUIClient.conserveMemory() to free all memory
allocated by the TQDomDocument and by the KXMLGUIFactory.
@short Create a GUI given a local XML file.
*/
public native void createGUI(String xmlfile, boolean _conserveMemory);
public native void createGUI(String xmlfile);
public native void createGUI();
/**
Enables the build of a standard help menu when calling createGUI().
The default behavior is to build one, you must call this function
to disable it
@short Enables the build of a standard help menu when calling createGUI().
*/
public native void setHelpMenuEnabled(boolean showHelpMenu);
public native void setHelpMenuEnabled();
/**
Return true when the help menu is enabled
@short Return true when the help menu is enabled
*/
public native boolean isHelpMenuEnabled();
/**
Returns true, if there is a menubar
@short Returns true, if there is a menubar
*/
public native boolean hasMenuBar();
/**
Returns a pointer to the menu bar.
If there is no menu bar yet one will be created.
@short Returns a pointer to the menu bar.
*/
public native KMenuBar kmenuBar();
/**
Returns a pointer to the status bar.
If there is no status bar yet, one will be created.
Note that tooltips for tdeactions in actionCollection() are not
automatically connected to this statusBar.
See the TDEActionCollection documentation for more details.
@short Returns a pointer to the status bar.
@see TDEActionCollection
*/
public native KStatusBar kstatusBar();
/**
Returns a pointer to the toolbar with the specified name.
This refers to toolbars created dynamically from the XML UI
framework. If the toolbar does not exist one will be created.
@param name The internal name of the toolbar. If no name is
specified "mainToolBar" is assumed.
@return A pointer to the toolbar
@short Returns a pointer to the toolbar with the specified name.
*/
public native TDEToolBar toolBar(String name);
public native TDEToolBar toolBar();
/**
@return An iterator over the list of all toolbars for this window.
@short
*/
// TQPtrListIteratorconfig.
@param config Config file to save the settings to.
@param groupName Group name to use. If not specified, the last used
group name is used
@short Save settings for statusbar, menubar and toolbar to their respective groups in the config file config.
*/
public native void saveMainWindowSettings(TDEConfig config, String groupName);
public native void saveMainWindowSettings(TDEConfig config);
/**
Sets whether TDEMainWindow should provide a menu that allows showing/hiding
the available toolbars ( using TDEToggleToolBarAction ) . In case there
is only one toolbar configured a simple 'Show \defaultSize The default size of the window
Typically this function replaces createGUI().
@short Configures the current windows and its actions in the typical KDE fashion.
@see StandardWindowOptions
*/
public native void setupGUI(TQSize defaultSize, int options, String xmlfile);
public native void setupGUI(TQSize defaultSize, int options);
public native void setupGUI(TQSize defaultSize);
/**
Returns a pointer to the mainwindows action responsible for the toolbars menu
@short Returns a pointer to the mainwindows action responsible for the toolbars menu
*/
public native TDEAction toolBarMenuAction();
/**
@short
*/
public native void setupToolbarMenuActions();
public native void finalizeGUI(KXMLGUIClientInterface client);
/**
@short
*/
public native void finalizeGUI(boolean force);
/**
@return true if a -geometry argument was given on the command line,
and this is the first window created (the one on which this option applies)
@short
*/
public native boolean initialGeometrySet();
/**
Used from Konqueror when reusing the main window.
@short
*/
public native void ignoreInitialGeometry();
/**
@short
*/
public native void setIcon(TQPixmap arg1);
/**
Show a standard configure toolbar dialog.
This slot can be connected dirrectly to the action to configure shortcuts.
This is very simple to do that by adding a single line
KStdAction.configureToolbars( guiFactory(), SLOT("configureToolbars()"),
actionCollection() );
@short Show a standard configure toolbar dialog.
*/
public native int configureToolbars();
/**
Makes a KDE compliant caption.
@param caption Your caption. Do not include the application name
in this string. It will be added automatically according to the KDE
standard.
@short Makes a KDE compliant caption.
*/
public native void setCaption(String caption);
/**
Makes a KDE compliant caption.
@param caption Your caption. Do not include the application name
in this string. It will be added automatically according to the KDE
standard.
@param modified Specify whether the document is modified. This displays
an additional sign in the title bar, usually "**".
@short Makes a KDE compliant caption.
*/
public native void setCaption(String caption, boolean modified);
/**
Make a plain caption without any modifications.
@param caption Your caption. This is the string that will be
displayed in the window title.
@short Make a plain caption without any modifications.
*/
public native void setPlainCaption(String caption);
/**
Open the help page for the application.
The application name is
used as a key to determine what to display and the system will attempt
to open \
KIconLoader &loader = TDEGlobal.iconLoader();
TQPixmap pixmap = loader.loadIcon( "help" );
toolBar(0).insertButton( pixmap, 0, SIGNAL("clicked()"),
this, SLOT("appHelpActivated()"), true, i18n("Help") );
@short Open the help page for the application.
*/
public native void appHelpActivated();
/**
Apply a state change
Enable and disable actions as defined in the XML rc file
@short Apply a state change
*/
public native void slotStateChanged(String newstate);
/**
Apply a state change
Enable and disable actions as defined in the XML rc file,
can "reverse" the state (disable the actions which should be
enabled, and vice-versa) if specified.
@short Apply a state change
*/
public native void slotStateChanged(String newstate, int arg2);
/**
Tell the main window that it should save its settings when being closed.
This is part of the auto-save-settings feature.
For everything related to toolbars this happens automatically,
but you have to call setSettingsDirty() in the slot that toggles
the visibility of the statusbar.
@short Tell the main window that it should save its settings when being closed.
*/
public native void setSettingsDirty();
/**
Session Management
Try to restore the toplevel widget as defined by the number (1..X).
If the session did not contain so high a number, the configuration
is not changed and false returned.
That means clients could simply do the following:
if (kapp.isRestored()){
int n = 1;
while (TDEMainWindow.canBeRestored(n)){
(new childMW).restore(n);
n++;
}
} else {
// create default application as usual
}
Note that TQWidget.show() is called implicitly in restore.
With this you can easily restore all toplevel windows of your
application.
If your application uses different kinds of toplevel
windows, then you can use TDEMainWindow.classNameOfToplevel(n)
to determine the exact type before calling the childMW
constructor in the example from above.
If your client has only one kind of toplevel widgets (which
should be pretty usual) then you should use the RESTORE-macro
for backwards compatibility with 3.1 and 3.0 branches:
if (kapp.isRestored())
RESTORE(childMW)
else {
// create default application as usual
}
The macro expands to the term above but is easier to use and
less code to write.
For new code or if you have more than one kind of toplevel
widget (each derived from TDEMainWindow, of course), you can
use the templated kRestoreMainWindows global functions:
if (kapp.isRestored())
kRestoreMainWindows< childMW1, childMW2, childMW3 >();
else {
// create default application as usual
}
Currently, these functions are provided for up to three
template arguments. If you need more, tell us. To help you in
deciding whether or not you can use kRestoreMainWindows, a
define KDE_RESTORE_MAIN_WINDOWS_NUM_TEMPLATE_ARGS is provided.
@short Session Management
@see #restore
@see #classNameOfToplevel
*/
public static native boolean canBeRestored(int number);
/**
Returns the className() of the number of the toplevel window which
should be restored.
This is only useful if your application uses
different kinds of toplevel windows.
@short Returns the className() of the number of the toplevel window which should be restored.
*/
public static native String classNameOfToplevel(int number);
/**
List of members of TDEMainWindow class.
@short List of members of TDEMainWindow class.
*/
// TQPtrListtrue. Returning false will
cancel the exiting. In the latter case, the last window will
remain visible. If TDEApplication.sessionSaving() is true, refusing
the exit will also cancel KDE logout.
@short Called before the very last window is closed, either by the user or indirectly by the session manager.
@see #queryClose
@see TDEApplication#sessionSaving
*/
protected native boolean queryExit();
/**
Called before the window is closed, either by the user or indirectly by
the session manager.
The purpose of this function is to prepare the window in a way that it is
safe to close it, i.e. without the user losing some data.
Default implementation returns true. Returning false will cancel
the closing, and, if TDEApplication.sessionSaving() is true, it will also
cancel KDE logout.
Reimplement this function to prevent the user from losing data.
Example:
switch ( KMessageBox.warningYesNoCancel( this,
i18n("Save changes to document foo?")) ) {
case KMessageBox.Yes :
// save document here. If saving fails, return false;
return true;
case KMessageBox.No :
return true;
default: // cancel
return false;
Note that you should probably not actually close the document from
within this method, as it may be called by the session manager before the
session is saved. If the document is closed before the session save occurs,
its location might not be properly saved. In addition, the session shutdown
may be canceled, in which case the document should remain open.
@short Called before the window is closed, either by the user or indirectly by the session manager.
@see #queryExit
@see TDEApplication#sessionSaving
*/
protected native boolean queryClose();
/**
Save your instance-specific properties. The function is
invoked when the session manager requests your application
to save its state.
You must not change the group of the tdeconfig object, since
TDEMainWindow uses one group for each window. Please
reimplement these function in childclasses.
Note: No user interaction is allowed
in this function!
@short Save your instance-specific properties.
*/
protected native void saveProperties(TDEConfig arg1);
/**
Read your instance-specific properties.
@short Read your instance-specific properties.
*/
protected native void readProperties(TDEConfig arg1);
/**
Save your application-wide properties. The function is
invoked when the session manager requests your application
to save its state.
This function is similar to saveProperties() but is only called for
the very first main window, regardless how many main window are open.
Override it if you need to save other data about your documents on
session end. sessionConfig is a config to which that data should be
saved. Normally, you don't need this function. But if you want to save
data about your documents that are not in opened windows you might need
it.
Default implementation does nothing.
@short Save your application-wide properties.
*/
protected native void saveGlobalProperties(TDEConfig sessionConfig);
/**
The counterpart of saveGlobalProperties().
Read the application-specific properties in again.
@short The counterpart of saveGlobalProperties().
*/
protected native void readGlobalProperties(TDEConfig sessionConfig);
protected native void savePropertiesInternal(TDEConfig arg1, int arg2);
protected native boolean readPropertiesInternal(TDEConfig arg1, int arg2);
/**
For inherited classes
@short For inherited classes
*/
protected native boolean settingsDirty();
/**
For inherited classes
@short For inherited classes
*/
protected native String settingsGroup();
/**
For inherited classes
Note that the group must be set before calling
@short For inherited classes Note that the group must be set before calling
*/
protected native void saveWindowSize(TDEConfig config);
/**
For inherited classes
Note that the group must be set before calling, and that
a -geometry on the command line has priority.
@short For inherited classes Note that the group must be set before calling, and that a -geometry on the command line has priority.
*/
protected native void restoreWindowSize(TDEConfig config);
protected native void parseGeometry(boolean parsewidth);
/**
Rebuilds the GUI after KEditToolbar changed the toolbar layout.
@short Rebuilds the GUI after KEditToolbar changed the toolbar layout.
@see #configureToolbars
*/
protected native void saveNewToolbarConfig();
/**
This slot does nothing.
It must be reimplemented if you want
to use a custom About Application dialog box. This slot is
connected to the About Application entry in the menu returned
by customHelpMenu.
Example:
void MyMainLevel.setupInterface()
{
..
menuBar().insertItem( i18n("&Help"), customHelpMenu() );
..
}
void MyMainLevel.showAboutApplication()
{
}
@short This slot does nothing.
*/
protected native void showAboutApplication();
/**
This slot should only be called in case you reimplement closeEvent() and
if you are using the "auto-save" feature. In all other cases,
setSettingsDirty() should be called instead to benefit from the delayed
saving.
Example:
void MyMainWindow.closeEvent( TQCloseEvent e )
{
// Save settings if auto-save is enabled, and settings have changed
if ( settingsDirty() && autoSaveSettings() )
saveAutoSaveSettings();
..
}
@short This slot should only be called in case you reimplement closeEvent() and if you are using the "auto-save" feature.
@see #setAutoSaveSettings
@see #setSettingsDirty
*/
protected native void saveAutoSaveSettings();
/** 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();
public native KXMLGUIClientInterface builderClient();
public native void setBuilderClient(KXMLGUIClientInterface client);
public native TDEInstanceInterface builderInstance();
public native void setBuilderInstance(TDEInstanceInterface instance);
public native TQWidget widget();
public native ArrayList containerTags();
/**
Creates a container (menubar/menu/toolbar/statusbar/separator/...)
from an element in the XML file
@param parent The parent for the container
@param index The index where the container should be inserted
into the parent container/widget
@param element The element from the DOM tree describing the
container (use it to access container specified
attributes or child elements)
@param id The id to be used for this container
@short Creates a container (menubar/menu/toolbar/statusbar/separator/.
*/
public native TQWidget createContainer(TQWidget parent, int index, TQDomElement element, int[] id);
/**
Removes the given (and previously via createContainer )
created container.
@short Removes the given (and previously via createContainer ) created container.
*/
public native void removeContainer(TQWidget container, TQWidget parent, TQDomElement element, int id);
public native ArrayList customTags();
public native int createCustomElement(TQWidget parent, int index, TQDomElement element);
public native void removeCustomElement(TQWidget parent, int id);
/**
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\