KMdiMainFrm Class Reference

Base class for all your special main frames. More...

#include <kmdimainfrm.h>

Collaboration diagram for KMdiMainFrm:


Public Types
enum	ExistsAs { DocumentView, ToolView, AnyView }
Public Slots
KMdiChildView *	createWrapper (QWidget *view, const QString &name, const QString &shortName)
virtual void	addWindow (KMdiChildView *pView, int flags=KMdi::StandardAdd)
void	addWindow (KMdiChildView *pView, int flags, int index)
virtual void	addWindow (KMdiChildView *pView, QPoint pos, int flags=KMdi::StandardAdd)
virtual void	addWindow (KMdiChildView *pView, QRect rectNormal, int flags=KMdi::StandardAdd)
virtual KMdiToolViewAccessor *	addToolWindow (QWidget pWnd, KDockWidget::DockPosition pos=KDockWidget::DockNone, QWidget pTargetWnd=0L, int percent=50, const QString &tabToolTip=0, const QString &tabCaption=0)
virtual void	deleteToolWindow (QWidget *pWnd)
virtual void	deleteToolWindow (KMdiToolViewAccessor *accessor)
KMdiToolViewAccessor *	createToolWindow ()
virtual void	removeWindowFromMdi (KMdiChildView *pWnd)
virtual void	closeWindow (KMdiChildView *pWnd, bool layoutTaskBar=true)
virtual void	slot_toggleTaskBar ()
virtual void	attachWindow (KMdiChildView *pWnd, bool bShow=true, bool bAutomaticResize=false)
virtual void	detachWindow (KMdiChildView *pWnd, bool bShow=true)
virtual void	childWindowCloseRequest (KMdiChildView *pWnd)
virtual void	closeAllViews ()
virtual void	iconifyAllViews ()
virtual void	closeActiveView ()
virtual void	switchToToplevelMode ()
virtual void	finishToplevelMode ()
virtual void	switchToChildframeMode ()
virtual void	finishChildframeMode ()
virtual void	switchToTabPageMode ()
virtual void	finishTabPageMode ()
virtual void	switchToIDEAlMode ()
virtual void	finishIDEAlMode (bool full=true)
void	setIDEAlModeStyle (int flags) KDE_DEPRECATED
void	setToolviewStyle (int flags)
bool	isViewTaskBarOn ()
virtual void	showViewTaskBar ()
virtual void	hideViewTaskBar ()
virtual void	fillWindowMenu ()
virtual void	cascadeWindows ()
virtual void	cascadeMaximized ()
virtual void	expandVertical ()
virtual void	expandHorizontal ()
virtual void	tilePragma ()
virtual void	tileAnodine ()
virtual void	tileVertically ()
virtual void	setFrameDecorOfAttachedViews (int frameDecor)
virtual void	setEnableMaximizedChildFrmMode (bool bEnable)
virtual void	activateNextWin ()
virtual void	activatePrevWin ()
virtual void	activateFirstWin ()
virtual void	activateLastWin ()
virtual void	activateView (int index)
void	prevToolViewInDock ()
void	nextToolViewInDock ()
Signals
void	lastChildFrmClosed ()
void	lastChildViewClosed ()
void	leftTopLevelMode ()
void	childViewIsDetachedNow (QWidget *)
void	collapseOverlapContainers ()
void	mdiModeHasBeenChangedTo (KMdi::MdiMode)
void	viewActivated (KMdiChildView *)
void	viewDeactivated (KMdiChildView *)
void	toggleTop ()
void	toggleLeft ()
void	toggleRight ()
void	toggleBottom ()
Public Member Functions
	KMdiMainFrm (QWidget parentWidget, const char name="", KMdi::MdiMode mdiMode=KMdi::ChildframeMode, WFlags flags=WType_TopLevel\|WDestructiveClose)
virtual	~KMdiMainFrm ()
void	setStandardMDIMenuEnabled (bool showModeMenu=true)
void	setManagedDockPositionModeEnabled (bool enabled)
bool	isInMaximizedChildFrmMode ()
KMdi::MdiMode	mdiMode ()
KMdiChildView *	activeWindow ()
virtual QPopupMenu *	taskBarPopup (KMdiChildView *pWnd, bool bIncludeWindowPopup=false)
virtual QPopupMenu *	windowPopup (KMdiChildView *pWnd, bool bIncludeTaskbarPopup=true)
virtual void	applyOptions ()
KMdiChildView *	findWindow (const QString &caption)
bool	windowExists (KMdiChildView *pWnd, ExistsAs as)
virtual bool	event (QEvent *e)
virtual void	setSysButtonsAtMenuPosition ()
virtual int	taskBarHeight ()
virtual void	setUndockPositioningOffset (QPoint offset)
KMdiIterator< KMdiChildView * > *	createIterator ()
void	deleteIterator (KMdiIterator< KMdiChildView * > *pIt)
QPopupMenu *	windowMenu () const
virtual void	setBackgroundColor (const QColor &c)
virtual void	setBackgroundPixmap (const QPixmap &pm)
void	setDefaultChildFrmSize (const QSize &sz)
QSize	defaultChildFrmSize ()
virtual void	setMinimumSize (int minw, int minh)
int	childFrameModeHeight ()
virtual void	setMenuForSDIModeSysButtons (KMenuBar *=0)
void	fakeSDIApplication ()
bool	isFakingSDIApplication () const
virtual bool	eventFilter (QObject obj, QEvent e)
void	findRootDockWidgets (QPtrList< KDockWidget > pRootDockWidgetList, QValueList< QRect > pPositionList)
void	setSwitching (const bool switching)
bool	switching (void) const
Static Public Member Functions
int	frameDecorOfAttachedViews ()
Protected Slots
virtual void	activateView (KMdiChildView *pWnd)
virtual void	taskbarButtonRightClicked (KMdiChildView *pWnd)
void	switchOffMaximizeModeForMenu (KMdiChildFrm *oldChild)
void	updateSysButtonConnections (KMdiChildFrm oldChild, KMdiChildFrm newChild)
void	windowMenuItemActivated (int id)
void	dockMenuItemActivated (int id)
void	popupWindowMenu (QPoint p)
void	dragEndTimeOut ()
void	closeViewButtonPressed ()
Protected Member Functions
virtual void	resizeEvent (QResizeEvent *)
virtual void	createTaskBar ()
virtual void	createMdiManager ()
void	blockClearingOfWindowMenu (bool bBlocked)
void	findToolViewsDockedToMain (QPtrList< KDockWidget > *list, KDockWidget::DockPosition dprtmw)
void	dockToolViewsIntoContainers (QPtrList< KDockWidget > &widgetsToReparent, KDockWidget *container)
QStringList	prepareIdealToTabs (KDockWidget *container)
void	idealToolViewsToStandardTabs (QStringList widgetNames, KDockWidget::DockPosition pos, int sizee)
KMdi::TabWidgetVisibility	tabWidgetVisibility ()
void	setTabWidgetVisibility (KMdi::TabWidgetVisibility)
KTabWidget *	tabWidget () const
Protected Attributes
KMdi::MdiMode	m_mdiMode
KMdiChildArea *	m_pMdi
KMdiTaskBar *	m_pTaskBar
QPtrList< KMdiChildView > *	m_pDocumentViews
QMap< QWidget , KMdiToolViewAccessor > *	m_pToolViews
KMdiChildView *	m_pCurrentWindow
QPopupMenu *	m_pWindowPopup
QPopupMenu *	m_pTaskBarPopup
QPopupMenu *	m_pWindowMenu
QPopupMenu *	m_pDockMenu
QPopupMenu *	m_pMdiModeMenu
QPopupMenu *	m_pPlacingMenu
KMenuBar *	m_pMainMenuBar
QPixmap *	m_pUndockButtonPixmap
QPixmap *	m_pMinButtonPixmap
QPixmap *	m_pRestoreButtonPixmap
QPixmap *	m_pCloseButtonPixmap
QToolButton *	m_pUndock
QToolButton *	m_pMinimize
QToolButton *	m_pRestore
QToolButton *	m_pClose
QPoint	m_undockPositioningOffset
bool	m_bMaximizedChildFrmMode
int	m_oldMainFrmHeight
int	m_oldMainFrmMinHeight
int	m_oldMainFrmMaxHeight
bool	m_bSDIApplication
KDockWidget *	m_pDockbaseAreaOfDocumentViews
QDomDocument *	m_pTempDockSession
bool	m_bClearingOfWindowMenuBlocked
QTimer *	m_pDragEndTimer
bool	m_bSwitching
KDockWidget *	m_leftContainer
KDockWidget *	m_rightContainer
KDockWidget *	m_topContainer
KDockWidget *	m_bottomContainer
Static Protected Attributes
KMdi::FrameDecor	m_frameDecoration = KMdi::KDELook
Friends
class	KMdiChildView
class	KMdiTaskBar

Detailed Description

Base class for all your special main frames.

It contains the child frame area (QMainWindow's central widget) and a child view taskbar for switching the MDI views. Most methods are virtual functions for later overriding.

Basically, this class provides functionality for docking/undocking view windows and manages the taskbar. Usually the programmer just need to know about this class and the child view class.

Your program mainwidget should inherit KMdiMainFrm. Then usually you'll just need addWindow() and removeWindowFromMdi() to control the views.

   class MyMainWindow : public KMdiMainFrm
   { .... };
   ...
   MyMainWindow mainframe;
   qApp->setMainWidget(&mainframe);
   mainframe->addWindow(view1); // put it under MDI control
   mainframe->addWindow(view2);

Most public and protected methods of this class are for program calls of the actions the user could click.

Dynamic switching the MDI mode can be done via switchToChildframeMode(), switchToToplevelMode(), switchToTabPageMode() or fakeSDIApplication() or asked via mdiMode(), isFakingSDIApplication().

This class provides already the "Window" menu needed in common MDI applications. Just insert it in your main menu:

 if (!isFakingSDIApplication()) {
    menuBar()->insertItem( tr("&Window"), windowMenu());
 }

Synchronize the positions of the MDI control buttons inserted in your mainmenu:

 void B_MainModuleWidget::initMenuBar()
 {
   setMenuForSDIModeSysButtons( menuBar());
 ...
 void B_MainModuleWidget::resizeEvent ( QResizeEvent *e)
 {
   KMdiMainFrm::resizeEvent( e);
   setSysButtonsAtMenuPosition();
 }

You can dynamically change the shape of the attached MDI views using setFrameDecorOfAttachedViews().

Additionally, here's a hint how to restore the mainframe's settings from config file:

    // restore MDI mode (toplevel, childframe, tabpage)
    int mdiMode = config->readIntEntry( "mainmodule session", "MDI mode", KMdi::ChildframeMode);
    switch (mdiMode) {
    case KMdi::ToplevelMode:
       {
          int childFrmModeHt = config->readIntEntry( "mainmodule session", "Childframe mode height", desktop()->height() - 50);
          mainframe->resize( m_pMdiMainFrm->width(), childFrmModeHt);
          mainframe->switchToToplevelMode();
       }
       break;
    case KMdi::ChildframeMode:
       break;
    case KMdi::TabPageMode:
       {
          int childFrmModeHt = m_pCfgFileManager->readIntEntry( "mainmodule session", "Childframe mode height", desktop()->height() - 50);
          mainframe->resize( m_pMdiMainFrm->width(), childFrmModeHt);
          mainframe->switchToTabPageMode();
       }
       break;
    default:
       break;
    }

    // restore a possible maximized Childframe mode
    bool maxChildFrmMode = config->readBoolEntry( "mainmodule session", "maximized childframes", true);
    mainframe->setEnableMaximizedChildFrmMode(maxChildFrmMode);

The maximized-Childframe mode means that currently all views are maximized in Childframe mode's application desktop.

This class provides placing algorithms in Childframe mode. Call tilePragma(), tileAnodine(), tileVertically(), cascadeWindows(), cascadeMaximized(), expandVertical(), expandHorizontal() for those actions.

activateView(KMdiChildView*) and activateView(int index) set the appropriate MDI child view as the active one. It will be raised, gets an active MDI frame and gets the focus. Call activeView() to find out what the current MDI view is.

Use detachWindow() and attachWindow() for docking the MDI views to desktop and back.

Connect accels of your program with activatePrevWin(), activateNextWin() and activateView(int index).

Note: KMdiChildViews can be added in 2 meanings: Either as a normal child view (usually containing user document views) or as a tool-view (usually containing status, info or control widgets). The tool-views can be added as floating dockwidgets or as stay-on-top desktop windows in tool style.

Here's an example how you can suggest things for the adding of views to the MDI control via flags:

 m_mapOfMdiWidgets.insert( pWnd, mh);
 unsigned int mdiFlags = KMdi::StandardAdd;
 if( !bShow)
    mdiFlags |= KMdi::Hide;
 if( !bAttach)
    mdiFlags |= KMdi::Detach;
 if( bMinimize)
    mdiFlags |= KMdi::Minimize;
 if( bToolWindow)
    mdiFlags |= KMdi::ToolWindow;
 if (m_pMdiMainFrm->isFakingSDIApplication()) {
    if (bAttach) { // fake an SDI app
       mdiFlags |= KMdi::Maximize;
    }
    else {
       m_pMdiMainFrm->addWindow( pWnd, QPoint(20, 20), KMdi::AddWindowFlags(mdiFlags));
       return;
    }
 }
 m_pMdiMainFrm->addWindow( pWnd, KMdi::AddWindowFlags(mdiFlags));

Further note: Pay attention to the fact that when you click on the close button of MDI views that their close event should be redirected to closeWindow(). Otherwise the mainframe class will not get noticed about the deleted view and a dangling pointer will remain in the MDI control. The closeWindow() or the removeWindowFromMdi() method is for that issue. The difference is closeWindow() deletes the view object. So if your application wants to control that by itself, call removeWindowFromMdi() and call delete by yourself. See also KMdiChildView::closeEvent() for tat issue.

Definition at line 204 of file kmdimainfrm.h.

Member Enumeration Documentation

enum KMdiMainFrm::ExistsAs

Returns whether this MDI child view is under MDI control (using addWindow() ) or not.

Definition at line 315 of file kmdimainfrm.h.

Constructor & Destructor Documentation

KMdiMainFrm::KMdiMainFrm ( QWidget * parentWidget,

const char * name = "",

KMdi::MdiMode mdiMode = KMdi::ChildframeMode,

WFlags flags = WType_TopLevel|WDestructiveClose

)

Constructor.

Definition at line 137 of file kmdimainfrm.cpp.
References applyOptions(), QObject::connect(), createMdiManager(), createTaskBar(), dragEndTimeOut(), fillWindowMenu(), QPtrList< KMdiChildView >::setAutoDelete(), QPopupMenu::setCheckable(), setMenuForSDIModeSysButtons(), switchToIDEAlMode(), switchToTabPageMode(), and switchToToplevelMode().

KMdiMainFrm::~KMdiMainFrm ( ) [virtual]

Destructor.

Definition at line 271 of file kmdimainfrm.cpp.
References QValueList::append(), QValueList::begin(), closeWindow(), QValueList::end(), QPtrList< KMdiChildView >::first(), lastChildViewClosed(), and QPtrList< KMdiChildView >::next().

Member Function Documentation

bool KMdiMainFrm::isInMaximizedChildFrmMode ( ) [inline]

Returns whether the application's MDI views are in maximized state or not.

Definition at line 280 of file kmdimainfrm.h.

KMdi::MdiMode KMdiMainFrm::mdiMode ( ) [inline]

Returns the MDI mode.
This can be one of the enumerations KMdi::MdiMode.
Definition at line 284 of file kmdimainfrm.h.
Referenced by detachWindow().

KMdiChildView * KMdiMainFrm::activeWindow ( )

Returns the focused attached MDI view.

Definition at line 879 of file kmdimainfrm.cpp.
Referenced by activateFirstWin(), activateLastWin(), activateNextWin(), activatePrevWin(), closeViewButtonPressed(), eventFilter(), switchToIDEAlMode(), and switchToTabPageMode().

QPopupMenu * KMdiMainFrm::taskBarPopup ( KMdiChildView * pWnd,

bool bIncludeWindowPopup = false

) [virtual]

Returns a popup menu filled according to the MDI view state.
You can override this method to insert additional entries there. The popup menu is usually popuped when the user clicks with the right mouse button on a taskbar entry. The default entries are: Undock/Dock, Restore/Maximize/Minimize, Close and an empty sub-popup ( windowPopup() ) menu called Operations.
Definition at line 910 of file kmdimainfrm.cpp.
References QPopupMenu::clear(), QPopupMenu::insertItem(), QPopupMenu::insertSeparator(), KMdiChildView::isAttached(), KMdiChildView::isMaximized(), KMdiChildView::isMinimized(), and windowPopup().
Referenced by taskbarButtonRightClicked(), and windowPopup().

QPopupMenu * KMdiMainFrm::windowPopup ( KMdiChildView * pWnd,

bool bIncludeTaskbarPopup = true

) [virtual]

Returns a popup menu with only a title "Window".
You can fill it with own operations entries on the MDI view. This popup menu is inserted as last menu item in taskBarPopup() .
Definition at line 899 of file kmdimainfrm.cpp.
References QPopupMenu::clear(), QPopupMenu::insertItem(), QPopupMenu::insertSeparator(), and taskBarPopup().
Referenced by taskBarPopup().

void KMdiMainFrm::applyOptions ( ) [virtual]

Called in the constructor (forces a resize of all MDI views).

Definition at line 313 of file kmdimainfrm.cpp.
References QPtrList< KMdiChildView >::first(), QWidget::height(), QPtrList< KMdiChildView >::next(), QWidget::resize(), and QWidget::width().
Referenced by KMdiMainFrm().

KMdiChildView * KMdiMainFrm::findWindow ( const QString & caption )

Returns the KMdiChildView belonging to the given caption string.

Definition at line 870 of file kmdimainfrm.cpp.
References KMdiChildView::caption(), QPtrList< KMdiChildView >::first(), and QPtrList< KMdiChildView >::next().

bool KMdiMainFrm::event ( QEvent * e ) [virtual]

Catches certain Qt events and processes it here.
Currently, here this catches only the KMdiViewCloseEvent (a KMdi user event) which is sent from itself in childWindowCloseRequest() right after a KMdiChildView::closeEvent() . The reason for this event to itself is simple: It just wants to break the function call stack. It continues the processing with calling closeWindow() . You see, a close() is translated to a closeWindow() . It is necessary that the main frame has to start an MDI view close action because it must remove the MDI view from MDI control, additionally.
This method calls QMainWindow::event , additionally.
Definition at line 1037 of file kmdimainfrm.cpp.
References closeWindow(), QPtrList< KMdiChildView >::current(), QPtrList< KMdiChildView >::first(), QTimer::isActive(), QPtrList< KMdiChildView >::next(), QApplication::sendEvent(), QTimer::start(), QTimer::stop(), and QEvent::type().

void KMdiMainFrm::setSysButtonsAtMenuPosition ( ) [virtual]

If there's a main menubar given, it will create the 4 maximize mode buttons there (undock, minimize, restore, close).

Definition at line 2065 of file kmdimainfrm.cpp.
References frameDecorOfAttachedViews().
Referenced by setMenuForSDIModeSysButtons().

virtual int KMdiMainFrm::taskBarHeight ( ) [inline, virtual]

Returns the height of the taskbar.

Definition at line 337 of file kmdimainfrm.h.

virtual void KMdiMainFrm::setUndockPositioningOffset ( QPoint offset ) [inline, virtual]

Sets an offset value that is used on detachWindow() .
The undocked window is visually moved on the desktop by this offset.
Definition at line 342 of file kmdimainfrm.h.
Referenced by switchToToplevelMode().

KMdiIterator<KMdiChildView*>* KMdiMainFrm::createIterator ( ) [inline]

If you don't want to know about the inner structure of the KMdi system, you can use this iterator to handle with the MDI view list in a more abstract way.
The iterator hides what special data structure is used in KMdi.
Definition at line 349 of file kmdimainfrm.h.
Referenced by activateFirstWin(), activateLastWin(), activateNextWin(), and activatePrevWin().

void KMdiMainFrm::deleteIterator ( KMdiIterator< KMdiChildView * > * pIt ) [inline]

Deletes an KMdiIterator created in the KMdi library (needed for the windows dll problem).

Definition at line 359 of file kmdimainfrm.h.

QPopupMenu* KMdiMainFrm::windowMenu ( ) const [inline]

Returns a popup menu that contains the MDI controlled view list.
Additionally, this menu provides some placing actions for these views. Usually, you insert this popup menu in your main menubar as "Window" menu.
Definition at line 365 of file kmdimainfrm.h.

virtual void KMdiMainFrm::setBackgroundColor ( const QColor & c ) [inline, virtual]

Sets a background color for the MDI view area widget.

Definition at line 369 of file kmdimainfrm.h.

virtual void KMdiMainFrm::setBackgroundPixmap ( const QPixmap & pm ) [inline, virtual]

Sets a background pixmap for the MDI view area widget.

Definition at line 373 of file kmdimainfrm.h.

void KMdiMainFrm::setDefaultChildFrmSize ( const QSize & sz ) [inline]

Sets a size that is used as the default size for a newly to the MDI system added KMdiChildView .
By default this size is 600x400. So all non-resized added MDI views appear in that size.
Definition at line 378 of file kmdimainfrm.h.
References KMdiChildArea::m_defaultChildFrmSize.

QSize KMdiMainFrm::defaultChildFrmSize ( ) [inline]

Returns the default size for a newly added KMdiChildView.
See setDefaultChildFrmSize() .
Definition at line 383 of file kmdimainfrm.h.
References KMdiChildArea::m_defaultChildFrmSize.
Referenced by detachWindow().

void KMdiMainFrm::setMinimumSize ( int minw,

int minh

) [virtual]

Do nothing when in Toplevel mode.

Definition at line 364 of file kmdimainfrm.cpp.

int KMdiMainFrm::childFrameModeHeight ( ) [inline]

Returns the Childframe mode height of this.
Makes only sense when in Toplevel mode.
Definition at line 392 of file kmdimainfrm.h.

void KMdiMainFrm::setMenuForSDIModeSysButtons ( KMenuBar * = 0 ) [virtual]

Tells the MDI system a QMenu where it can insert buttons for the system menu, undock, minimize, restore actions.
If no such menu is given, KMdi simply overlays the buttons at the upper right-hand side of the main widget.
Definition at line 1996 of file kmdimainfrm.cpp.
References frameDecorOfAttachedViews(), QToolButton::setAutoRaise(), and setSysButtonsAtMenuPosition().
Referenced by KMdiMainFrm(), and setFrameDecorOfAttachedViews().

int KMdiMainFrm::frameDecorOfAttachedViews ( ) [inline, static]

Returns:
the decoration of the window frame of docked (attached) MDI views

Definition at line 404 of file kmdimainfrm.h.
Referenced by KMdiChildFrm::doResize(), KMdiChildFrmCaption::heightHint(), KMdiChildFrmCaption::mousePressEvent(), KMdiChildFrmCaption::mouseReleaseEvent(), KMdiChildFrmCaption::paintEvent(), KMdiChildFrm::redecorateButtons(), setEnableMaximizedChildFrmMode(), setMenuForSDIModeSysButtons(), setSysButtonsAtMenuPosition(), KMdiChildFrm::showSystemMenu(), KMdiChildFrmCaption::slot_moveViaSystemMenu(), KMdiChildFrm::systemMenu(), and updateSysButtonConnections().

void KMdiMainFrm::fakeSDIApplication ( )

An SDI application user interface is faked:

an opened view is always maximized

buttons for maximized childframe mode aren't inserted in the main menubar

taskbar and windowmenu are not created/updated.

Definition at line 2572 of file kmdimainfrm.cpp.

bool KMdiMainFrm::isFakingSDIApplication ( ) const [inline]

Returns:
if we are faking an SDI application (fakeSDIApplication())

Definition at line 415 of file kmdimainfrm.h.
Referenced by popupWindowMenu().

bool KMdiMainFrm::eventFilter ( QObject * obj,

QEvent * e

) [virtual]

Definition at line 1076 of file kmdimainfrm.cpp.
References activeWindow(), KMdiChildArea::focusTopChild(), KMdiChildView::isAttached(), QWidget::isHidden(), QFocusEvent::reason(), KMdiChildArea::topChild(), QEvent::type(), and KMdiChildView::updateTimeStamp().

void KMdiMainFrm::findRootDockWidgets ( QPtrList< KDockWidget > * pRootDockWidgetList,

QValueList< QRect > * pPositionList

)

find the root dockwidgets and store their geometry

Definition at line 1163 of file kmdimainfrm.cpp.
References QValueList::append(), QPtrList::append(), QPtrListIterator::current(), QPtrList::isEmpty(), QWidget::isTopLevel(), QWidget::mapToGlobal(), QWidget::parentWidget(), QPoint::x(), and QPoint::y().
Referenced by switchToChildframeMode(), and switchToToplevelMode().

KMdiChildView * KMdiMainFrm::createWrapper ( QWidget * view,

const QString & name,

const QString & shortName

) [slot]

addWindow demands a KMdiChildView.
This method wraps every QWidget in such an object and this way you can every widget put under MDI control.
Definition at line 373 of file kmdimainfrm.cpp.
References QBoxLayout::addWidget(), QWidget::icon(), QString::latin1(), QWidget::reparent(), KMdiChildView::setCaption(), QWidget::setIcon(), KMdiChildView::setTabCaption(), and KMdiChildView::trackIconAndCaptionChanges().

void KMdiMainFrm::addWindow ( KMdiChildView * pView,

int flags = KMdi::StandardAdd

) [virtual, slot]

One of the most important methods at all! Adds a KMdiChildView to the MDI system.
The main frame takes it under control. You can specify here whether:

the view should be attached or detached.

shown or hidden

maximized, minimized or restored (normalized)

added as tool view (stay-on-top and toplevel) or added as document-type view.</LI?

Definition at line 397 of file kmdimainfrm.cpp.
Referenced by addWindow().

void KMdiMainFrm::addWindow ( KMdiChildView * pView,

int flags,

int index

) [slot]

One of the most important methods at all! Adds a KMdiChildView to the MDI system.
The main frame takes it under control. You can specify here whether:

the view should be attached or detached.

shown or hidden

maximized, minimized or restored (normalized)

added as tool view (stay-on-top and toplevel) or added as document-type view.</LI?

Parameters:

index defines an index of tab, after which the new tab will be inserted. This param have not any sence in ChildFrame mode. If index == -1 then the tab will be appended.

Since:
3.3

Definition at line 402 of file kmdimainfrm.cpp.
References activateView(), addToolWindow(), KMdiTaskBar::addWinButton(), QPtrList< KMdiChildView >::append(), attachWindow(), KMdiChildView::caption(), childViewIsDetachedNow(), childWindowCloseRequest(), QObject::connect(), QPtrList< KMdiChildView >::count(), detachWindow(), dockMenuItemActivated(), KMdiChildArea::getCascadePoint(), QWidget::icon(), QPtrList< KMdiChildView >::insert(), KMdiChildView::isAttached(), KMdiChildView::isMaximized(), KMdiChildView::maximize(), KMdiChildView::mdiParent(), KMdiChildView::minimize(), QWidget::move(), QWidget::setFocus(), KMdiChildView::show(), KMdiChildView::tabCaption(), and windowMenuItemActivated().

void KMdiMainFrm::addWindow ( KMdiChildView * pView,

QPoint pos,

int flags = KMdi::StandardAdd

) [virtual, slot]

See the method above for more details.
Additionally, it moves to point pos.
Definition at line 518 of file kmdimainfrm.cpp.
References addWindow(), KMdiChildView::isAttached(), QWidget::move(), KMdiChildView::restoreGeometry(), KMdiChildView::setRestoreGeometry(), and QRect::size().

void KMdiMainFrm::addWindow ( KMdiChildView * pView,

QRect rectNormal,

int flags = KMdi::StandardAdd

) [virtual, slot]

See the method above for more details.
Additionally, it sets the geometry.
Definition at line 507 of file kmdimainfrm.cpp.
References addWindow(), KMdiChildView::isAttached(), QWidget::setGeometry(), and KMdiChildView::setRestoreGeometry().

KMdiToolViewAccessor * KMdiMainFrm::addToolWindow ( QWidget * pWnd,

KDockWidget::DockPosition pos = KDockWidget::DockNone,

QWidget * pTargetWnd = 0L,

int percent = 50,

const QString & tabToolTip = 0,

const QString & tabCaption = 0

) [virtual, slot]

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.
Definition at line 548 of file kmdimainfrm.cpp.
References QWidget::caption(), QWidget::geometry(), QWidget::icon(), QMap< QWidget *, KMdiToolViewAccessor * >::insert(), and QRect::topLeft().
Referenced by addWindow().

KMdiToolViewAccessor * KMdiMainFrm::createToolWindow ( ) [slot]

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.

Definition at line 530 of file kmdimainfrm.cpp.

void KMdiMainFrm::removeWindowFromMdi ( KMdiChildView * pWnd ) [virtual, slot]

Removes a KMdiChildView from the MDI system and from the main frame`s control.
Note: The view will not be deleted, but it's getting toplevel (reparent to 0)!
Definition at line 696 of file kmdimainfrm.cpp.
References KMdiChildView::activate(), activateView(), attachWindow(), childWindowCloseRequest(), QTabWidget::count(), KMdiChildArea::destroyChildButNotItsView(), detachWindow(), QObject::disconnect(), dockMenuItemActivated(), KMdiTaskBar::getButton(), KMdiChildArea::getVisibleChildCount(), KMdiChildView::isAttached(), KMdiChildView::isToolView(), lastChildViewClosed(), KMdiChildView::m_bToolView, KMdiChildFrm::m_pClient, KMdiChildView::mdiParent(), QTabWidget::page(), QWidget::parentWidget(), KMdiTaskBar::removeWinButton(), QWidget::reparent(), KMdiChildArea::topChild(), and windowMenuItemActivated().

void KMdiMainFrm::closeWindow ( KMdiChildView * pWnd,

bool layoutTaskBar = true

) [virtual, slot]

Removes a KMdiChildView from the MDI system and from the main frame`s control.
Note: The view will be deleted!
Definition at line 785 of file kmdimainfrm.cpp.
References KMdiChildView::activate(), QTabWidget::count(), QPtrList< KMdiChildView >::count(), QPtrList< KMdiChildView >::current(), KMdiChildArea::destroyChild(), KMdiChildArea::getVisibleChildCount(), KMdiChildView::isAttached(), QPtrList< KMdiChildView >::last(), lastChildViewClosed(), KMdiChildFrm::m_pClient, KMdiChildView::mdiParent(), QTabWidget::page(), QWidget::parentWidget(), QPtrList< KMdiChildView >::removeRef(),

kmdi Library API Documentation

KMdiMainFrm Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation