top level container widget that can be moved and resized by the user More...

#include <window.hpp>

Inheritance diagram for window:

[legend]

Public Types
enum	attributes { EMPTY = (1 << 0), BORDER = (1 << 1), TITLE = (1 << 2), MINMAX = (1 << 3), RESIZE = (1 << 4), SYSTEM = (1 << 5) }

Public Types inherited from widget
enum	damage { DAMAGE_NONE = 0, DAMAGE_ALL = (1<<0), DAMAGE_LABEL = (1<<1), DAMAGE_VALUE = (1<<2), DAMAGE_SCROLL = (1<<3), DAMAGE_MOVED = (1<<4), DAMAGE_RESERVED1 = (1<<5), DAMAGE_RESERVED2 = (1<<6), DAMAGE_RESERVED3 = (1<<7) }
	bit mask indicating what needs to be redrawn More...

Public Member Functions
	window (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...

virtual	~window ()
	destructor More...

virtual void	draw () const
	draws the widget More...

enum attributes	get_attributes () const
	gets the window attributes More...

unsigned char const *	get_title () const
	gets the windows title More...

void	set_attributes (unsigned const i_attributes)
	set the window attributes More...

void	set_title (unsigned char const *i_str)
	sets the windows title More...

Public Member Functions inherited from group
	group (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...

virtual	~group ()
	destructor More...

virtual void	set_damage (unsigned int const i_damage=DAMAGE_NONE)
	sets damage mask More...

virtual int	add (widget *const i_widget)
	add child widget More...

virtual enum event_response	event_key_default (enum scancodes const i_scan)
	default scan code event handler More...

virtual enum event_response	event_key (struct event_key const &i_event)
	handle key event More...

virtual enum event_response	event_mouse (struct event_mouse const &i_event)
	handle mouse event More...

virtual void	focus_enter ()
	handle entering focus More...

virtual void	focus_leave ()
	handle leaving focus More...

void	set_focus (widget &i_widget)
	set widget focus More...

Public Member Functions inherited from widget
	widget (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...

virtual	~widget ()
	destructor More...

virtual bool	close (bool const i_shutting_down)
	called when widget is about to be destroyed More...

bool	contains (int const i_pos_x, int const i_pos_y) const
	test if point is contained within the widget More...

bool	contains (struct box const &i_box) const
	test if rectangular region is contained within the widget More...

void	get_box (struct box &o_box) const
	gets the rectangular region this widget occupies More...

bool	get_can_focus () const
	gets whether or not the widget can receive focus More...

bool	get_enabled () const
	gets whether or not the widget is enabled More...

bool	get_has_focus () const
	gets whether or not the widget has focus More...

group *const	get_parent () const
	gets the parent widget More...

void *	get_user_data () const
	gets user defined data pointer More...

bool	get_visible () const
	gets whether or not the widget is visible More...

int	get_pos_x () const
	gets the relative x position of the widget More...

int	get_pos_y () const
	gets the relative y position of the widget More...

unsigned int	get_len_x () const
	gets the horizontal length of the widget More...

unsigned int	get_len_y () const
	gets the vertical length of the widget More...

virtual void	move (int const i_pos_x, int const i_pos_y)
	move the widget to a new position More...

virtual void	resize (unsigned int const i_len_x, unsigned int const i_len_y)
	resize the widget More...

void	set_can_close (bool const i_can_close)
	set internal indicator if widget can be closed More...

void	set_disabled ()
	disable the widget More...

void	set_enabled ()
	enable the widget

void	set_hidden ()
	hide the widget More...

virtual void	set_parent (group *const i_parent)
	sets the parent group of the widget More...

void	set_user_data (void *io_user_data)
	sets the user defined data pointer More...

void	set_visible ()
	sets the widget as visible More...

void	translate_screen (int const o_pos_x, int const o_pos_y) const
	translate a widgets relative coordinates to screen coordinates More...

Protected Attributes
unsigned char *	m_title

enum attributes	m_attributes

Protected Attributes inherited from group
widget *	m_focused
	widget that has focus

size_t	m_slot
	focused widget slot (index into array)

struct array	m_array
	widget container

Protected Attributes inherited from widget
unsigned int	m_damage

unsigned int	m_flags

struct box	m_box

group *	m_parent

void *	m_user_data

Private Member Functions
	window (const window &)

window &	operator= (window const &)

Additional Inherited Members
Protected Types inherited from widget
enum	flags { VISIBLE = (1 << 0), ENABLED = (1 << 1), CAN_FOCUS = (1 << 2), HAS_FOCUS = (1 << 3), CAN_CLOSE = (1 << 4) }

Detailed Description

top level container widget that can be moved and resized by the user

Member Enumeration Documentation

◆ attributes

enum window::attributes

Enumerator
EMPTY	no bit mask flags are set
BORDER	window has a border
TITLE	window has a title
MINMAX	window has a minimize and maximize button
RESIZE	window can be resized
SYSTEM	window has a system menu

Constructor & Destructor Documentation

◆ window()

window::window	(	int const	i_pos_x,
		int const	i_pos_y,
		unsigned int const	i_len_x,
		unsigned int const	i_len_y
	)

constructor

Parameters

[in]	i_pos_x	x position to place widget
[in]	i_pos_y	y position to place widget
[in]	i_len_x	x length of widget
[in]	i_len_y	y length of widget

Returns: none

◆ ~window()

window::~window ( )

virtual

destructor

Returns: none

Member Function Documentation

◆ draw()

void window::draw ( ) const

virtual

draws the widget

This method should not be called directly.

See also: widget::draw for details.

Reimplemented from group.

Reimplemented in menu.

◆ get_attributes()

window::attributes window::get_attributes ( ) const

inline

gets the window attributes

Returns: window attributes

◆ get_title()

unsigned char const * window::get_title ( ) const

inline

gets the windows title

Returns: 0 window does not have a title; !0 pointer to window title

◆ set_attributes()

void window::set_attributes ( unsigned const i_attributes )

inline

set the window attributes

Parameters

[in] i_attributes bit mask of window::attributes

Returns: none

◆ set_title()

void window::set_title ( unsigned char const * i_title )

inline

sets the windows title

Returns: none

Member Data Documentation

◆ m_attributes

window::m_attributes

protected

bit mask of window attributes

◆ m_title

window::m_title

protected

window title

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

window.hpp
window.dox
window.cpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ attributes

Constructor & Destructor Documentation

◆ window()

◆ ~window()

Member Function Documentation

◆ draw()

◆ get_attributes()

◆ get_title()

◆ set_attributes()

◆ set_title()

Member Data Documentation

◆ m_attributes

◆ m_title