kmdi Library API Documentation

KMDI::MainWindow Class Reference

Collaboration diagram for KMDI::MainWindow:

Collaboration graph
[legend]
List of all members.

Public Slots

void prevToolViewInDock ()
void nextToolViewInDock ()

Signals

void collapseOverlapContainers ()
void toggleTop ()
void toggleLeft ()
void toggleRight ()
void toggleBottom ()

Public Member Functions

 MainWindow (QWidget *parentWidget, const char *name="")
virtual ~MainWindow ()
TabWidget * tabWidget ()
KMDI::ToolViewAccessor * createToolWindow ()
KMDI::ToolViewAccessor * addToolWindow (QWidget *pWnd, KDockWidget::DockPosition pos=KDockWidget::DockNone, QWidget *pTargetWnd=0L, int percent=50, const QString &tabToolTip=0, const QString &tabCaption=0)
void deleteToolWindow (KMDI::ToolViewAccessor *accessor)
void deleteToolWindow (QWidget *pWnd)
void setToolViewStyle (int flags)

Protected Member Functions

void findToolViewsDockedToMain (QPtrList< KDockWidget > *list, KDockWidget::DockPosition dprtmw)
void dockToolViewsIntoContainers (QPtrList< KDockWidget > &widgetsToReparent, KDockWidget *container)

Protected Attributes

KMDIPrivate::GUIClient * m_guiClient
QMap< QWidget *, KMDI::ToolViewAccessor * > * m_toolViews
KDockWidget * m_leftContainer
KDockWidget * m_rightContainer
KDockWidget * m_topContainer
KDockWidget * m_bottomContainer
KMDI::TabWidget * m_tabWidget

Friends

class KMDI::ToolViewAccessor

Detailed Description

Definition at line 72 of file mainwindow.h.


Constructor & Destructor Documentation

KMDI::MainWindow::MainWindow (  QWidget *  parentWidget,
const char *  name = ""
) 
 

Constructor.

Definition at line 100 of file mainwindow.cpp.

KMDI::MainWindow::~MainWindow (   )  [virtual]
 

Destructor.

Definition at line 116 of file mainwindow.cpp.

References m_toolViews.


Member Function Documentation

TabWidget * KMDI::MainWindow::tabWidget (   ) 
 

get the central tabwidget add all your content as child to this widget or as multiple tabs

Returns:
tabwidget in central of window

Definition at line 249 of file mainwindow.cpp.

References m_tabWidget.

ToolViewAccessor * KMDI::MainWindow::createToolWindow (   ) 
 

Using this method you have to use the setWidget method of the access object, and it is very recommendet, that you use the widgetContainer() method for the parent of your newly created widget.

Returns:
created toolview

Definition at line 254 of file mainwindow.cpp.

KMDI::ToolViewAccessor * KMDI::MainWindow::addToolWindow (  QWidget *  pWnd,
KDockWidget::DockPosition  pos = KDockWidget::DockNone,
QWidget *  pTargetWnd = 0L,
int  percent = 50,
const QString &  tabToolTip = 0,
const QString &  tabCaption = 0
) 
 

Usually called from addWindow() when adding a tool view window.

It reparents the given widget as toplevel and stay-on-top on the application's main widget.

Parameters:
pWnd widget for the toolview
pos docking position
Returns:
created toolview

Definition at line 259 of file mainwindow.cpp.

References QWidget::caption(), KMDI::ToolViewAccessor::d, QWidget::geometry(), QMap::insert(), m_toolViews, KMDI::ToolViewAccessor::place(), and QRect::topLeft().

void KMDI::MainWindow::deleteToolWindow (  KMDI::ToolViewAccessor *  accessor  ) 
 

delete the toolview belonging to the given accessor

Parameters:
accessor toolview to delete

Definition at line 295 of file mainwindow.cpp.

Referenced by deleteToolWindow().

void KMDI::MainWindow::deleteToolWindow (  QWidget *  pWnd  ) 
 

delete the toolview belonging to the given pWnd

Parameters:
pWnd toolview to be deleted

Definition at line 300 of file mainwindow.cpp.

References QMap::contains(), deleteToolWindow(), and m_toolViews.

void KMDI::MainWindow::setToolViewStyle (  int  flags  ) 
 

Sets the appearance of the toolview tabs.

Parameters:
flags See KMDI::ToolviewStyle.

Definition at line 310 of file mainwindow.cpp.

References QMap::begin(), QMap::end(), KMDI::IconOnly, m_toolViews, KMDI::DockContainer::setStyle(), KMDI::TextAndIcon, and KMDI::TextOnly.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmdi Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Dec 1 04:12:47 2005 by doxygen 1.4.3 written by Dimitri van Heesch, © 1997-2003