• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeparts
 

tdeparts

  • KParts
  • DockMainWindow
Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KParts::DockMainWindow Class Reference

#include <dockmainwindow.h>

Inheritance diagram for KParts::DockMainWindow:
KDockMainWindow KParts::PartBase TDEMainWindow KXMLGUIClient KXMLGUIBuilder KXMLGUIClient

Public Member Functions

 DockMainWindow (TQWidget *parent=0L, const char *name=0L, WFlags f=(WFlags) WDestructiveClose)
virtual ~DockMainWindow ()
- Public Member Functions inherited from KDockMainWindow
 KDockMainWindow (TQWidget *parent=0L, const char *name=0L, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
KDockManager * manager () const
void setMainDockWidget (KDockWidget *dockwidget)
KDockWidget * getMainDockWidget () const
KDockWidget * createDockWidget (const TQString &name, const TQPixmap &pixmap, TQWidget *parent=0L, const TQString &strCaption=TQString::null, const TQString &strTabPageLabel=TQString::fromLatin1(" "))
void writeDockConfig (TQDomElement &base)
void readDockConfig (TQDomElement &base)
void writeDockConfig (TDEConfig *c=0L, TQString group=TQString::null)
void readDockConfig (TDEConfig *c=0L, TQString group=TQString::null)
void activateDock ()
TQPopupMenu * dockHideShowMenu () const
void makeDockVisible (KDockWidget *dock)
void makeDockInvisible (KDockWidget *dock)
void makeWidgetDockVisible (TQWidget *widget)
void setView (TQWidget *widget)
 TDEMainWindow (TQWidget *parent=0, const char *name=0, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
 TDEMainWindow (int cflags, TQWidget *parent=0, const char *name=0, WFlags f=(WFlags)(WType_TopLevel|WDestructiveClose))
TDEPopupMenu * helpMenu (const TQString &aboutAppText=TQString::null, bool showWhatsThis=true)
TDEPopupMenu * customHelpMenu (bool showWhatsThis=true)
virtual void show ()
virtual void hide ()
bool restore (int number, bool show=true)
virtual KXMLGUIFactory * guiFactory ()
void createGUI (const TQString &xmlfile=TQString::null, bool _conserveMemory=true)
void setHelpMenuEnabled (bool showHelpMenu=true)
bool isHelpMenuEnabled ()
bool hasMenuBar ()
KMenuBar * menuBar ()
KStatusBar * statusBar ()
TDEToolBar * toolBar (const char *name=0)
TQPtrListIterator< TDEToolBar > toolBarIterator ()
TDEAccel * accel ()
void setFrameBorderWidth (int)
void setAutoSaveSettings (const TQString &groupName=TQString::fromLatin1("MainWindow"), bool saveWindowSize=true)
void resetAutoSaveSettings ()
bool autoSaveSettings () const
TQString autoSaveGroup () const
void applyMainWindowSettings (TDEConfig *config, const TQString &groupName, bool force)
void applyMainWindowSettings (TDEConfig *config, const TQString &groupName=TQString::null)
void saveMainWindowSettings (TDEConfig *config, const TQString &groupName=TQString::null)
void setStandardToolBarMenuEnabled (bool enable)
bool isStandardToolBarMenuEnabled () const
void createStandardStatusBarAction ()
void setupGUI (int options=ToolBar|Keys|StatusBar|Save|Create, const TQString &xmlfile=TQString::null)
void setupGUI (TQSize defaultSize, int options=ToolBar|Keys|StatusBar|Save|Create, const TQString &xmlfile=TQString::null)
TDEAction * toolBarMenuAction ()
void setupToolbarMenuActions ()
virtual void finalizeGUI (KXMLGUIClient *client)
void finalizeGUI (bool force)
bool initialGeometrySet () const
void ignoreInitialGeometry ()
TQSize sizeForCentralWidgetSize (TQSize size) KDE_DEPRECATED
virtual void setIcon (const TQPixmap &)
 KXMLGUIBuilder (TQWidget *widget)
KXMLGUIClient * builderClient () const
void setBuilderClient (KXMLGUIClient *client)
TDEInstance * builderInstance () const
void setBuilderInstance (TDEInstance *instance)
TQWidget * widget ()
virtual TQStringList containerTags () const
virtual TQWidget * createContainer (TQWidget *parent, int index, const TQDomElement &element, int &id)
virtual void removeContainer (TQWidget *container, TQWidget *parent, TQDomElement &element, int id)
virtual TQStringList customTags () const
virtual int createCustomElement (TQWidget *parent, int index, const TQDomElement &element)
virtual void removeCustomElement (TQWidget *parent, int id)
 KXMLGUIClient ()
 KXMLGUIClient (KXMLGUIClient *parent)
TDEAction * action (const char *name) const
virtual TDEAction * action (const TQDomElement &element) const
virtual TDEActionCollection * actionCollection () const
virtual TDEInstance * instance () const
virtual TQDomDocument domDocument () const
virtual TQString xmlFile () const
virtual TQString localXMLFile () const
void setXMLGUIBuildDocument (const TQDomDocument &doc)
TQDomDocument xmlguiBuildDocument () const
void setFactory (KXMLGUIFactory *factory)
KXMLGUIFactory * factory () const
KXMLGUIClient * parentClient () const
void insertChildClient (KXMLGUIClient *child)
void removeChildClient (KXMLGUIClient *child)
const TQPtrList< KXMLGUIClient > * childClients ()
void setClientBuilder (KXMLGUIBuilder *builder)
KXMLGUIBuilder * clientBuilder () const
void reloadXML ()
void plugActionList (const TQString &name, const TQPtrList< TDEAction > &actionList)
void unplugActionList (const TQString &name)
void addStateActionEnabled (const TQString &state, const TQString &action)
void addStateActionDisabled (const TQString &state, const TQString &action)
StateChange getActionsToChangeForState (const TQString &state)
void beginXMLPlug (TQWidget *)
void endXMLPlug ()
void prepareXMLUnplug (TQWidget *)
- Public Member Functions inherited from KParts::PartBase
 PartBase ()
virtual ~PartBase ()
void setPartObject (TQObject *object)
TQObject * partObject () const

Protected Slots

void createGUI (KParts::Part *part)
virtual void slotSetStatusBarText (const TQString &)
- Protected Slots inherited from KDockMainWindow
void slotDockWidgetUndocked ()
void saveNewToolbarConfig ()
virtual void showAboutApplication ()
void saveAutoSaveSettings ()
- Protected Slots inherited from TDEMainWindow
void saveNewToolbarConfig ()
virtual void showAboutApplication ()
void saveAutoSaveSettings ()

Protected Member Functions

virtual void createShellGUI (bool create=true)
- Protected Member Functions inherited from KDockMainWindow
virtual void virtual_hook (int id, void *data)
void paintEvent (TQPaintEvent *e)
void childEvent (TQChildEvent *e)
void resizeEvent (TQResizeEvent *e)
virtual void closeEvent (TQCloseEvent *)
virtual bool queryExit ()
virtual bool queryClose ()
virtual void saveProperties (TDEConfig *)
virtual void readProperties (TDEConfig *)
virtual void saveGlobalProperties (TDEConfig *sessionConfig)
virtual void readGlobalProperties (TDEConfig *sessionConfig)
void savePropertiesInternal (TDEConfig *, int)
bool readPropertiesInternal (TDEConfig *, int)
bool settingsDirty () const
TQString settingsGroup () const
void saveWindowSize (TDEConfig *config) const
void restoreWindowSize (TDEConfig *config)
void parseGeometry (bool parsewidth)
virtual void setInstance (TDEInstance *instance)
virtual void setXMLFile (const TQString &file, bool merge=false, bool setXMLDoc=true)
virtual void setLocalXMLFile (const TQString &file)
virtual void setXML (const TQString &document, bool merge=false)
virtual void setDOMDocument (const TQDomDocument &document, bool merge=false)
virtual void conserveMemory ()
virtual void stateChanged (const TQString &newstate, ReverseStateChange reverse=StateNoReverse)
- Protected Member Functions inherited from KParts::PartBase
virtual void setInstance (TDEInstance *instance)
virtual void setInstance (TDEInstance *instance, bool loadPlugins)
void loadPlugins (TQObject *parent, KXMLGUIClient *parentGUIClient, TDEInstance *instance)
void setPluginLoadingMode (PluginLoadingMode loadingMode)

Additional Inherited Members

- Public Types inherited from KDockMainWindow
enum  CreationFlags
enum  StandardWindowOptions
- Public Slots inherited from KDockMainWindow
int configureToolbars ()
virtual void setCaption (const TQString &caption)
virtual void setCaption (const TQString &caption, bool modified)
virtual void setPlainCaption (const TQString &caption)
void appHelpActivated (void)
virtual void slotStateChanged (const TQString &newstate)
void slotStateChanged (const TQString &newstate, KXMLGUIClient::ReverseStateChange)
void setSettingsDirty ()
- Signals inherited from KDockMainWindow
void dockWidgetHasUndocked (KDockWidget *)
- Static Public Member Functions inherited from KDockMainWindow
static bool canBeRestored (int number)
static const TQString classNameOfToplevel (int number)
static TQPtrList< TDEMainWindow > * getMemberList ()
- Public Attributes inherited from KDockMainWindow
 ToolBar
 Keys
 StatusBar
 Save
 Create
- Static Public Attributes inherited from KDockMainWindow
static TQPtrList< TDEMainWindow > * memberList
- Protected Types inherited from KParts::PartBase
enum  PluginLoadingMode { DoNotLoadPlugins = 0, LoadPlugins = 1, LoadPluginsIfEnabled = 2 }
- Protected Attributes inherited from KDockMainWindow
KDockWidget * mainDockWidget
KDockManager * dockManager

Detailed Description

A KPart-aware main window with ability for docking widgets, whose user interface is described in XML.

Inherit your main dock-window from this class and don't forget to call setXMLFile() in the inherited constructor.

It implements all internal interfaces in the case of a KDockMainWindow as host: the builder and servant interface (for menu merging).

Definition at line 47 of file dockmainwindow.h.

Constructor & Destructor Documentation

DockMainWindow::DockMainWindow ( TQWidget *  parent = 0L,
const char *  name = 0L,
WFlags  f = (WFlags)WDestructiveClose 
)

Constructor, same signature as KDockMainWindow.

Definition at line 61 of file dockmainwindow.cpp.

DockMainWindow::~DockMainWindow ( )
virtual

Destructor.

Definition at line 68 of file dockmainwindow.cpp.

Member Function Documentation

void DockMainWindow::createGUI ( KParts::Part *  part)
protectedslot

Create the GUI (by merging the host's and the active part's)

Called on startup and whenever the active part changes. For this you need to connect this slot to the PartManager::activePartChanged() signal

Parameters
partThe active part (set to 0L if no part).

Definition at line 73 of file dockmainwindow.cpp.

void DockMainWindow::slotSetStatusBarText ( const TQString &  text)
protectedvirtualslot

Called when the active part wants to change the statusbar message.

Reimplement if your dock-mainwindow has a complex statusbar (with several items)

Definition at line 125 of file dockmainwindow.cpp.


The documentation for this class was generated from the following files:
  • dockmainwindow.h
  • dockmainwindow.cpp

tdeparts

Skip menu "tdeparts"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeparts

Skip menu "tdeparts"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeparts by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.