SkyGI::FrameWindow Class Reference

Inheritance diagram for SkyGI::FrameWindow:[legend]Collaboration diagram for SkyGI::FrameWindow:[legend]List of all members.

Public Member Functions
	FrameWindow (Window *pParent, const Rect &rFrame, const String &szTitle, unsigned int nWindowLayoutFlags, unsigned int uiFrameWindowFlags=0, unsigned int uiFlags=0)
virtual void	Paint (const Rect &rDirty)
virtual void	Created ()
virtual bool	Activated ()
virtual bool	Deactivated ()
Window *	GetView ()
void	AttachView (Window *pView, bool bKeepView=false)
unsigned int	GetFrameWindowFlags ()
void	Sized (const Point &pDelta)
TitleWindow *	GetTitleWindow ()
void	SetTitle (const String &cTitle)
void	SetMenu (Menu *pMenu)
Menu *	GetMenu ()
void	AddStatusBar (bool bAdd=true)
void	AddStatusBar (StatusBar *pStatusBar)
void	RemoveStatusBar (StatusBar *pStatusBar)
StatusBar *	GetStatusBar ()
void	AddToolBar (ToolBar *pToolBar)
ToolBar *	GetToolBar (int iIndex)
void	RemoveToolBar (ToolBar *pToolBar)
void	Moved (const Point &pDelta)
virtual void	Center ()
void	KeyDown (const InputEvent &nInputEvent)
int	Show (bool bSynchron=true)
virtual void	SetMinimumSize (const Point &pSize)

---

Constructor & Destructor Documentation

FrameWindow::FrameWindow	(	Window *	pParent,
		const Rect &	rFrame,
		const String &	szTitle,
		unsigned int	nWindowLayoutFlags,
		unsigned int	uiFrameWindowFlags = 0,
		unsigned int	uiFlags = 0
	)

---

Member Function Documentation

void FrameWindow::Paint

(

const Rect &

rDirty

)

[virtual]

Paint window content

Description:

This function gets called whenever an area of the window has to be redrawn. Usually you should only draw from inside the Paint function. If you need to redraw a window (when lets say some content must be updated), simply call Invalidate() which will then (asynchronly) call this paint function.

Usually you should draw the background using Window::DrawBackground(rDirty) and the border with DrawBorder(rRect). This way the user has full control over the appearance of your window, meaning he can change the background and border style.
The window content area itself is defined by the border margin and the window margin. Every window may define a margin. If you draw content into this window always make sure to not draw into the margin area. Additionally, the border has a margin too. As the user has full control to select any border for your window make sure to user the current borders margin when drawing window content. the dra Window::Paint() just redraws the background using DrawBackground. Overload this member function to add custom dawing code

Overload this member function to add custom dawing code

Parameters:

rDirty

- Dirty rectangular region which has to be redrawn. Prior entering this function the painters clip region is automatically set to this dirty region.

See also:

DrawBorder, DrawBackground, Border, GetBorder, GetBorder::Margin, GetMargin

Reimplemented from SkyGI::Window.

void FrameWindow::Created

(

)

[virtual]

Window has been created

Description:

This function gets called when the window has been created and may be used to make post initialization

Overload this member function to get notified when the window was created.

Reimplemented from SkyGI::Window.

bool FrameWindow::Activated

(

)

[virtual]

Window activated

Description:

Called for the top level window when the window gets activated. A top level window gets a focus and is actually activated/deactivated. Child windows only get the focus but they don't get activated/deactivated

Returns:

true if window got activated

Reimplemented from SkyGI::Window.

Reimplemented in SkyGI::PopupMenu.

bool FrameWindow::Deactivated

(

)

[virtual]

Window deactivated

Description:

Called for the top level window when the window gets deactivated. A top level window gets a focus and is actually activated/deactivated. Child windows only get the focus but they don't get activated/deactivated

Returns:

true if window got deactivated

Reimplemented from SkyGI::Window.

Reimplemented in SkyGI::PopupMenu.

Window * FrameWindow::GetView

(

)

Get the associated View

Description:

Get the View associated with the FrameWindow. A View was either set with AttachView or implicity created by the FrameWindows constructor

Returns:

The View associated with the FrameWindow or NULL if no View is present

Reimplemented in SkyGI::CopyDialog, SkyGI::DeleteDialog, SkyGI::FileDialog, SkyGI::FileHandlerSelectDialog, SkyGI::FontSelectDialog, SkyGI::InputBox, SkyGI::ListViewSelectDialog, SkyGI::PopupMenu, SkyGI::MessageBox, SkyGI::PasswordDialog, and SkyGI::QueryEditDialog.

void FrameWindow::AttachView	(	Window *	pView,
		bool	bKeepView = false
	)

Set the View

Description:

Sets the View for the FrameWindow. If a View is already present it will get deleted if bKeepView is false. The view gets attached to the FrameWindow automatically

Examples:

button.cpp, clipboard.cpp, directoryview.cpp, diskdevice.cpp, dnd.cpp, eventsource.cpp, eventthread.cpp, images.cpp, infopanel.cpp, layoutview.cpp, listview.cpp, localization.cpp, messagebox.cpp, networkinterface.cpp, progressbar.cpp, radiobutton.cpp, rect.cpp, splitter.cpp, styleview.cpp, tabview.cpp, textview.cpp, thread.cpp, and videoview.cpp.

unsigned int SkyGI::FrameWindow::GetFrameWindowFlags

(

)

[inline]

void FrameWindow::Sized

(

const Point &

pDelta

)

[virtual]

Called when window is resized

Description:

Overload this function to get notified when the window is resized

Note:

Call this function from the overloaded function to perform automatic window layout on child windows

Parameters:

pDelta

- Size the window was resized

See also:

MoveTo, MoveBy, SetRect, Moved, Layout

Reimplemented from SkyGI::Window.

TitleWindow * FrameWindow::GetTitleWindow

(

)

Get the TitleWindow of an FrameWindow

Returns:

The TitleWindow or NULL is no TitleWindow is present

Examples:

button.cpp, clipboard.cpp, directoryview.cpp, diskdevice.cpp, dnd.cpp, eventsource.cpp, eventthread.cpp, images.cpp, infopanel.cpp, layoutview.cpp, listview.cpp, localization.cpp, messagebox.cpp, networkinterface.cpp, progressbar.cpp, radiobutton.cpp, rect.cpp, splitter.cpp, styleview.cpp, tabview.cpp, textview.cpp, thread.cpp, and videoview.cpp.

void FrameWindow::SetTitle

(

const String &

cTitle

)

[virtual]

Set the FrameWindow Title

Description:

Sets the title of the FrameWindow and redraws the TitleWindow to show the new title.

See also:

Window::SetTitle, GetTitle

Reimplemented from SkyGI::Window.

void FrameWindow::SetMenu

(

Menu *

pMenu

)

Menu * FrameWindow::GetMenu

(

)

Reimplemented in SkyGI::PopupMenu.

void FrameWindow::AddStatusBar

(

bool

bAdd = true

)

Examples:

videoview.cpp.

void FrameWindow::AddStatusBar

(

StatusBar *

pStatusBar

)

void FrameWindow::RemoveStatusBar

(

StatusBar *

pStatusBar

)

StatusBar * FrameWindow::GetStatusBar

(

)

void FrameWindow::AddToolBar

(

ToolBar *

pToolBar

)

ToolBar * FrameWindow::GetToolBar

(

int

iIndex

)

void FrameWindow::RemoveToolBar

(

ToolBar *

pToolBar

)

Remove a toolbar

Description:

Removes the toolbar and calls the toolbars destroy method

void FrameWindow::Moved

(

const Point &

pDelta

)

[virtual]

Called when window is moved

Description:

Overload this function to get notified when the window is moved

Note:

Call this function from the overloaded function to perform automatic window layout on child windows

Parameters:

pDelta

- Distance the window was moved

See also:

MoveTo, MoveBy, SetRect, Sized, Layout

Reimplemented from SkyGI::Window.

void FrameWindow::Center

(

)

[virtual]

void FrameWindow::KeyDown

(

const InputEvent &

nInputEvent

)

[virtual]

Reimplemented from SkyGI::Window.

int FrameWindow::Show

(

bool

bSynchron = true

)

[virtual]

Make window visible

Description:

Makes the window visible. If bSynchron is true the window will be displayed immediately. If bSynchron is false a message will be sent to message queue to actually show this window after initial redraw messages or to draw into the window right after the Show() call but before it gets visible.

Returns:

0

Reimplemented from SkyGI::Window.

Examples:

listview.cpp.

void FrameWindow::SetMinimumSize

(

const Point &

pSize

)

[virtual]

Set minimum window size

Description:

Sets the minimum window size. The resulting minimum size is the maximum of the value set with this function and the value returned from GetSizeHint(SIZE_HINT_MINIMUM).
The window minimum has no effect for methods like SetSize or SetRect, only operations performed directly by the user (e.g. resizing the ApplicationWindow or moving a splitter) are effected by the minmum

See also:

GetMinimumSize, GetSizeHint

Reimplemented from SkyGI::Window.

---