KMdiChildArea Class Reference

#include <tdemdichildarea.h>

Inherits TQFrame.

Public Slots
void	cascadeWindows ()
void	cascadeMaximized ()
void	expandVertical ()
void	expandHorizontal ()
void	focusTopChild ()
void	tilePragma ()
void	tileAnodine ()
void	tileVertically ()
void	layoutMinimizedChildren ()

Signals
void	noMaximizedChildFrmLeft (KMdiChildFrm *)
void	nowMaximized (bool)
void	sysButtonConnectionsMustChange (KMdiChildFrm *, KMdiChildFrm *)
void	popupWindowMenu (TQPoint)
void	lastChildFrmClosed ()

Public Member Functions
	KMdiChildArea (TQWidget *parent)
	~KMdiChildArea ()
void	manageChild (KMdiChildFrm *lpC, bool bShow=true, bool bCascade=true)
void	destroyChild (KMdiChildFrm *child, bool focusTopChild=true)
void	destroyChildButNotItsView (KMdiChildFrm *lpC, bool bFocusTopChild=true)
void	setTopChild (KMdiChildFrm *child, bool setFocus=false)
KMdiChildFrm *	topChild () const
int	getVisibleChildCount () const
TQPoint	getCascadePoint (int indexOfWindow=-1)
void	setMdiCaptionFont (const TQFont &fnt)
void	setMdiCaptionActiveForeColor (const TQColor &clr)
void	setMdiCaptionActiveBackColor (const TQColor &clr)
void	setMdiCaptionInactiveForeColor (const TQColor &clr)
void	setMdiCaptionInactiveBackColor (const TQColor &clr)

Static Public Member Functions
static void	getCaptionColors (const TQPalette &pal, TQColor &activeBG, TQColor &activeFG, TQColor &inactiveBG, TQColor &inactiveFG) TDE_DEPRECATED

Public Attributes
TQPtrList< KMdiChildFrm > *	m_pZ
TQSize	m_defaultChildFrmSize

Protected Member Functions
void	tileAllInternal (int maxWnds)
virtual void	resizeEvent (TQResizeEvent *)
void	mousePressEvent (TQMouseEvent *e)
void	childMinimized (KMdiChildFrm *lpC, bool bWasMaximized)

Protected Attributes
TQFont	m_captionFont
TQColor	m_captionActiveBackColor
TQColor	m_captionActiveForeColor
TQColor	m_captionInactiveBackColor
TQColor	m_captionInactiveForeColor
int	m_captionFontLineSpacing

Friends
class	KMdiChildFrmCaption
class	KMdiChildFrm

Detailed Description

Internal class.

The main frame widget KMdiMainFrm consists of 2 child widgets. One is this class. It's the widget where the child frames (emulated toplevel MDI views) live in. This class is the manager for the child frame widgets because it controls the Z-order widget stack of KMdiChildFrm's. It provides all placing and positioning algorithms for docked (attached) MDI views.

KMdiChildArea doesn't know anything about the actual MDI views. It only knows and manages the frame widgets of attached MDI views. All actions and stuff concerning only to childframes are handled here.

Definition at line 52 of file tdemdichildarea.h.

Constructor & Destructor Documentation

KMdiChildArea()

KMdiChildArea::KMdiChildArea

(

TQWidget *

parent

)

Consruction.

Note: This class needn't to know about KMdiMainFrm .

Definition at line 48 of file tdemdichildarea.cpp.

~KMdiChildArea()

KMdiChildArea::~KMdiChildArea

(

)

Destructor : THERE should be no child windows anymore... Howewer it simply deletes all the child widgets :)

Definition at line 66 of file tdemdichildarea.cpp.

Member Function Documentation

cascadeMaximized

void KMdiChildArea::cascadeMaximized ( )

slot

Cascades all windows resizing them to the maximum available size.

Definition at line 404 of file tdemdichildarea.cpp.

cascadeWindows

void KMdiChildArea::cascadeWindows ( )

slot

Cascades all windows resizing them to the minimum size.

Definition at line 382 of file tdemdichildarea.cpp.

childMinimized()

void KMdiChildArea::childMinimized ( KMdiChildFrm *  lpC, bool  bWasMaximized  )

protected

Internally used.

Actions that are necessary when an MDI view gets minimized

Definition at line 319 of file tdemdichildarea.cpp.

destroyChild()

void KMdiChildArea::destroyChild	(	KMdiChildFrm *	child,
		bool	focusTopChild = true
	)

Destroys a managed KMdiChildFrm Also deletes the client attached to this child.

Definition at line 109 of file tdemdichildarea.cpp.

destroyChildButNotItsView()

void KMdiChildArea::destroyChildButNotItsView	(	KMdiChildFrm *	lpC,
		bool	bFocusTopChild = true
	)

Destroys a managed KMdiChildFrm Clients attached to the KMdiChildFrm are not deleted.

Definition at line 141 of file tdemdichildarea.cpp.

expandHorizontal

void KMdiChildArea::expandHorizontal ( )

slot

Maximize all windows but only in horizontal direction.

Definition at line 460 of file tdemdichildarea.cpp.

expandVertical

void KMdiChildArea::expandVertical ( )

slot

Maximize all windows but only in vertical direction.

Definition at line 438 of file tdemdichildarea.cpp.

focusTopChild

void KMdiChildArea::focusTopChild ( )

slot

Gives focus to the topmost child if it doesn't get focus automatically or you want to wait to give it focus.

Definition at line 355 of file tdemdichildarea.cpp.

getCaptionColors()

void KMdiChildArea::getCaptionColors ( const TQPalette &  pal, TQColor &  activeBG, TQColor &  activeFG, TQColor &  inactiveBG, TQColor &  inactiveFG  )

static

Gets all caption colors, consistent with current WM settings (or other Desktop settings e.g.

system settings for win32) This method is useful not only for KMDI child windows. Colors are returned via activeBG, activeFG, inactiveBG, inactiveFG references.

Deprecated:

Use TDEGlobalSettings::activeTitleColor(), TDEGlobalSettings::activeTextColor(), TDEGlobalSettings::inactiveTitleColor() and TDEGlobalSettings::inactiveTextColor() instead.

Definition at line 780 of file tdemdichildarea.cpp.

getCascadePoint()

TQPoint KMdiChildArea::getCascadePoint

(

int

indexOfWindow = -1

)

Calculates the cascade point for the given index.

If index is -1 the cascade point is calculated for the window following the last window

Parameters

indexOfWindow

the index of the window in relation the z-ordered window list

Definition at line 258 of file tdemdichildarea.cpp.

getVisibleChildCount()

int KMdiChildArea::getVisibleChildCount

(

)

const

Returns the number of visible children.

Definition at line 482 of file tdemdichildarea.cpp.

lastChildFrmClosed

void KMdiChildArea::lastChildFrmClosed ( )

signal

Signals that the last attached (docked) MDI view has been closed.

Note: Detached MDI views can remain.

layoutMinimizedChildren

void KMdiChildArea::layoutMinimizedChildren ( )

slot

Position and layout the minimized child frames.

Definition at line 723 of file tdemdichildarea.cpp.

manageChild()

void KMdiChildArea::manageChild	(	KMdiChildFrm *	lpC,
		bool	bShow = true,
		bool	bCascade = true
	)

Appends a new KMdiChildFrm to this manager.

The child is shown,raised and gets focus if this window has it.

Definition at line 72 of file tdemdichildarea.cpp.

mousePressEvent()

void KMdiChildArea::mousePressEvent ( TQMouseEvent *  e )

protected

Shows the 'Window' popup menu on right mouse button click.

Definition at line 249 of file tdemdichildarea.cpp.

noMaximizedChildFrmLeft

void KMdiChildArea::noMaximizedChildFrmLeft ( KMdiChildFrm *  )

signal

Signals that there aren't maximized child frames any more.

nowMaximized

void KMdiChildArea::nowMaximized ( bool  )

signal

Signals that the child frames are maximized now.

popupWindowMenu

void KMdiChildArea::popupWindowMenu ( TQPoint  )

signal

Signals a KMdiMainFrm that the 'Window' popup menu must be shown.

resizeEvent()

void KMdiChildArea::resizeEvent ( TQResizeEvent *  e )

protectedvirtual

Automatically resizes a maximized MDI view and layouts the positions of minimized MDI views.

Definition at line 227 of file tdemdichildarea.cpp.

setMdiCaptionActiveBackColor()

void KMdiChildArea::setMdiCaptionActiveBackColor

(

const TQColor &

clr

)

Sets the background color of the active MDI childframe window captions A relayout does not occur when using this function.

Definition at line 764 of file tdemdichildarea.cpp.

setMdiCaptionActiveForeColor()

void KMdiChildArea::setMdiCaptionActiveForeColor

(

const TQColor &

clr

)

Sets the foreground color of the active MDI childframe window caption A relayout does not occur when using this function.

Definition at line 759 of file tdemdichildarea.cpp.

setMdiCaptionFont()

void KMdiChildArea::setMdiCaptionFont

(

const TQFont &

fnt

)

Sets the MDI childframe window caption font A relayout does not occur when using this function.

Definition at line 747 of file tdemdichildarea.cpp.

setMdiCaptionInactiveBackColor()

void KMdiChildArea::setMdiCaptionInactiveBackColor

(

const TQColor &

clr

)

Sets the background color of inactive MDI childframe window captions A relayout does not occur when using this function.

Definition at line 774 of file tdemdichildarea.cpp.

setMdiCaptionInactiveForeColor()

void KMdiChildArea::setMdiCaptionInactiveForeColor

(

const TQColor &

clr

)

Sets the foreground color of inactive MDI childframe window captions A relayout does not occur when using this function.

Definition at line 769 of file tdemdichildarea.cpp.

setTopChild()

void KMdiChildArea::setTopChild	(	KMdiChildFrm *	child,
		bool	setFocus = false
	)

Brings the child to the top of the stack The child is focused if setFocus is true.

If setFocus is false, the child is just raised.

Todo:

: setting the maximum size doesn't work properly - fix this later

Definition at line 171 of file tdemdichildarea.cpp.

sysButtonConnectionsMustChange

void KMdiChildArea::sysButtonConnectionsMustChange ( KMdiChildFrm *  , KMdiChildFrm *    )

signal

Signals a KMdiMainFrm that the signal/slot connections of the system buttons in the menubar (only in Maximize mode) must be updated to another MDI view because the focused MDI view has changed.

tileAllInternal()

void KMdiChildArea::tileAllInternal ( int  maxWnds )

protected

Internally used for the tile algorithm.

Definition at line 500 of file tdemdichildarea.cpp.

tileAnodine

void KMdiChildArea::tileAnodine ( )

slot

Tile Anodine.

Definition at line 602 of file tdemdichildarea.cpp.

tilePragma

void KMdiChildArea::tilePragma ( )

slot

Tile Pragma.

Definition at line 494 of file tdemdichildarea.cpp.

tileVertically

void KMdiChildArea::tileVertically ( )

slot

Tile all the windows in the child area vertically.

Definition at line 676 of file tdemdichildarea.cpp.

topChild()

KMdiChildFrm * KMdiChildArea::topChild ( ) const

inline

Returns the topmost child (the active one) or 0 if there are no children.

Note that the topmost child may be also hidded , if ALL the windows are minimized.

Definition at line 141 of file tdemdichildarea.h.

Friends And Related Function Documentation

KMdiChildFrm

friend class KMdiChildFrm

friend

Definition at line 55 of file tdemdichildarea.h.

KMdiChildFrmCaption

friend class KMdiChildFrmCaption

friend

Definition at line 54 of file tdemdichildarea.h.

Member Data Documentation

m_captionActiveBackColor

TQColor KMdiChildArea::m_captionActiveBackColor

protected

The foreground color of the active MDI childframe window caption.

Definition at line 79 of file tdemdichildarea.h.

m_captionActiveForeColor

TQColor KMdiChildArea::m_captionActiveForeColor

protected

The background color of the active MDI childframe window captions.

Definition at line 84 of file tdemdichildarea.h.

m_captionFont

TQFont KMdiChildArea::m_captionFont

protected

The MDI childframe window caption font.

Definition at line 74 of file tdemdichildarea.h.

m_captionFontLineSpacing

int KMdiChildArea::m_captionFontLineSpacing

protected

Definition at line 96 of file tdemdichildarea.h.

m_captionInactiveBackColor

TQColor KMdiChildArea::m_captionInactiveBackColor

protected

The foreground color of inactive MDI childframe window captions.

Definition at line 89 of file tdemdichildarea.h.

m_captionInactiveForeColor

TQColor KMdiChildArea::m_captionInactiveForeColor

protected

The background color of inactive MDI childframe window captions.

Definition at line 94 of file tdemdichildarea.h.

m_defaultChildFrmSize

TQSize KMdiChildArea::m_defaultChildFrmSize

the default size of an newly created childframe

Definition at line 69 of file tdemdichildarea.h.

m_pZ

TQPtrList<KMdiChildFrm>* KMdiChildArea::m_pZ

Z Order stack of KMdiChildFrm childframe windows (top=last)

Definition at line 64 of file tdemdichildarea.h.

---

The documentation for this class was generated from the following files:

• tdemdichildarea.h
• tdemdichildarea.cpp