A Window is a rectangular sub-area of another window. More...

#include <gui_tk.h>

Inheritance diagram for GUI::Window:

Public Member Functions
void	addWindowHandler (Window_Callback *handler)
	Add an event handler.
void	removeWindowHandler (Window_Callback *handler)
	Remove an event handler.
	Window (Window *parent, int x, int y, int w, int h)
	Create a subwindow of the given parent window.
virtual	~Window ()
	Destructor.
virtual void	resize (int w, int h)
	Resize this window to the given dimensions.
virtual int	getWidth () const
	Return this window's width.
virtual int	getHeight () const
	Return this window's height.
virtual void	move (int x, int y)
	Move this window to the given position relative to the parent window's origin.
virtual int	getX () const
	Return this window's X position relative to the parent's top left corner.
virtual int	getY () const
	Return this window's Y position relative to the parent's top left corner.
virtual int	getScreenX () const
	Return this window's contents' X position relative to the screen's top left corner.
virtual int	getScreenY () const
	Return this window's contents' Y position relative to the screen's top left corner.
virtual void	paintAll (Drawable &d) const
	Draw this window's content including all children.
virtual void	paint (Drawable &d) const
	Draw this window's content.
virtual void	setVisible (bool v)
	Show or hide this window.
virtual bool	isVisible () const
	Returns `true` if this window is visible.
Window *	getParent () const
	Return parent window.
Screen *	getScreen ()
	Get the topmost window (the Screen)
virtual bool	hasFocus () const
	Returns `true` if this window has currently the keyboard focus.
virtual bool	mouseMoved (int x, int y)
	Mouse was moved. Returns true if event was handled.
virtual void	mouseMovedOutside (void)
	Mouse was moved outside the window (when it was once inside the window)
virtual bool	mouseDragged (int x, int y, MouseButton button)
	Mouse was moved while a button was pressed. Returns true if event was handled.
virtual bool	mouseDown (int x, int y, MouseButton button)
	Mouse was pressed. Returns true if event was handled.
virtual bool	mouseUp (int x, int y, MouseButton button)
	Mouse was released. Returns true if event was handled.
virtual bool	mouseClicked (int x, int y, MouseButton button)
	Mouse was clicked. Returns true if event was handled.
virtual bool	mouseDoubleClicked (int x, int y, MouseButton button)
	Mouse was double-clicked. Returns true if event was handled.
virtual bool	mouseDownOutside (MouseButton button)
	Transient windows by default should disappear.
virtual bool	keyDown (const Key &key)
	Key was pressed. Returns true if event was handled.
virtual bool	keyUp (const Key &key)
	Key was released. Returns true if event was handled.
virtual bool	raise ()
	Put this window on top of all it's siblings. Preserves relative order.
virtual void	lower ()
	Put this window below all of it's siblings. Does not preserve relative order.
Window *	getChild (int n)
	Return the `n` th child.
unsigned int	getChildCount (void)
Public Attributes
bool	first_tabbable = false
	`first` element of a tabbable list
bool	last_tabbable = false
	`last` element of a tabbable list
Protected Member Functions
virtual void	addChild (Window *child)
	Register child window.
virtual void	removeChild (Window *child)
	Remove child window.
void	setDirty ()
	Mark this window and all parents as dirty.
virtual void	setClipboard (const String &s)
	Replace clipboard content.
virtual const String &	getClipboard ()
	Get clipboard content.
	Window ()
	Default constructor. Only used in class Screen. Do not use.
virtual void	focusChanged (bool gained)
	Called whenever the focus changes.
Protected Attributes
int	width
	Width of the window.
int	height
	Height of the window.
int	x
	X position relative to parent.
int	y
	Y position relative to parent.
bool	dirty
	`true` if anything changed in this window or one of it's children
bool	visible
	`true` if this window should be visible on screen.
bool	tabbable
	`true` if the user should be allowed to TAB to this window.
Window *const	parent
	Parent window.
Window *	mouseChild
	Child window of last button-down event.
bool	transient
	`true` if this window is transient (such as menu popus)
bool	toplevel
	`toplevel` window
bool	mouse_in_window
	`mouse` is within the boundaries of the window
std::list< Window * >	children
	Child windows.
std::list< Window_Callback * >	movehandlers
	List of registered event handlers.
Friends
class	ToplevelWindow
class	TransientWindow
class	WindowInWindow
class	Menu

Detailed Description

A Window is a rectangular sub-area of another window.

Windows are arranged hierarchically. A Window cannot leave its parent's area. They may contain their own buffer or share it with their parent.

Usually, every GUI element is a subclass of Window. Note that this is not a GUI window with decorations like border and title bar. See ToplevelWindow for that.

Definition at line 579 of file gui_tk.h.