CL_DisplayWindowDescription Class Reference
[clanDisplay Window]

Display window description class. More...

#include <display_window_description.h>

Inheritance diagram for CL_DisplayWindowDescription:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_DisplayWindowDescription ()
 Constructs a window description with default values.
 CL_DisplayWindowDescription (const CL_String &title)
 Constructs a window description with default values and a title.
 CL_DisplayWindowDescription (const CL_String &title, const CL_Rect &position, bool client_area)
 Constructs a window description with default values, a title and a position.
 CL_DisplayWindowDescription (const CL_String &title, const CL_Size &size, bool client_area)
 Constructs a window description with default values, a title and a size.
 CL_DisplayWindowDescription (const CL_Rect &position, bool client_area)
 Constructs a window description with default values and a position.
 CL_DisplayWindowDescription (const CL_DisplayWindowDescription &copy)
 Constructs a DisplayWindowDescription.
virtual ~CL_DisplayWindowDescription ()
Attributes

const CL_Stringget_title () const
 Returns the window title stored in the description.
bool get_decorations () const
 Returns true if the window shall be created with decorations.
CL_Size get_size () const
 Returns the size of the window stored in description.
CL_Rect get_position () const
 Returns the initial position of the window.
bool get_position_client_area () const
 Returns if the client area is used for the initial position of the window.
bool is_fullscreen () const
 Returns if window should be initially fullscreen.
int get_flipping_buffers () const
 Returns the amount of flipping buffers to be created.
int get_swap_interval () const
 Returns the swap interval to be used for the window.
bool get_allow_resize () const
 Returns true if window should be resizeable.
int get_bpp () const
 Returns the numbers of bytes per pixel in the window.
int get_refresh_rate () const
 Returns the refresh rate of the displaymode.
bool is_layered () const
 Returns true if window is layered (black is transparent).
bool has_caption () const
 Returns true if a title bar is shown.
bool has_sysmenu () const
 Returns true if the window has a window menu on its title bar.
bool has_minimize_button () const
 Returns true if the window has a minimize button.
bool has_maximize_button () const
 Returns true if the window has a maximize button.
bool has_border () const
 Returns true if the window has a border.
bool is_tool_window () const
 Returns true if the window is a tool window.
bool is_dialog () const
 Returns true if the window is a dialog window.
bool is_visible () const
 Returns true if the window is initially visible.
bool is_topmost () const
 Returns true if the window should be placed above all non-topmost windows.
bool get_using_gui_window_cache () const
 Returns true if window from the window cache should be used. (GUI Only).
bool has_drop_shadow () const
 Returns true if the window is drawn with a drop shadow effect.
CL_DisplayWindow get_owner () const
 Returns the window owning this one.
bool get_tablet_context () const
 Returns true if a tablet context is to be created for the window.
CL_SharedPtr
< CL_DisplayWindowDescriptionData
get_data (const CL_String &data_name) const
 Returns the object stored in the given data name.
int get_depth_size () const
 Returns the minimum required depth buffer.
int get_stencil_size () const
 Returns the minimum required stencil buffer.
int get_fullscreen_monitor () const
 Returns the index of the monitor to go fullscreen on. See CL_ScreenInfo.
Operations

CL_DisplayWindowDescriptionoperator= (const CL_DisplayWindowDescription &copy)
 Copy assignment operator.
void show_caption (bool value=true)
 Controls if a title bar is shown or not.
void show_sysmenu (bool value=true)
 Sets if the window has a window menu on its title bar.
void show_minimize_button (bool value=true)
 Sets if the window has a minimize button.
void show_maximize_button (bool value=true)
 Sets if the window has a maximize button.
void show_border (bool value=true)
 Sets if the window has a border. DO NOT USE (This function is not implemented and is to be removed in ClanLib 2.4).
void set_decorations (bool decorations)
 Sets if windows should have decorations.
void set_visible (bool value=true)
 Toggles whether the window is created as initially visible.
void set_topmost (bool value=true)
 Sets if the window should be placed above all non-topmost windows.
void set_tool_window (bool value=true)
 Flags the window to be a tool window to the windowing system.
void set_dialog_window (bool value=true)
 Flags the window to be a dialog window to the windowing system.
void set_drop_shadow (bool value=true)
 Enables a drop shadow effect on the window.
void set_owner_window (const CL_DisplayWindow &owner)
 Specifies another window which owns this one.
void set_title (const CL_String &title)
 Sets the title of the window.
void set_size (const CL_Size &size, bool client_area)
 Sets the size of the window (including window frame).
void set_position (const CL_Rect &position, bool client_area)
 Sets the position of the window (including window frame).
void set_fullscreen (bool fullscreen=true, int monitor=0)
 Makes the window initially fullscreen.
void set_flipping_buffers (int num_buffers=2)
 Sets the amount of flipping buffers to be used.
void set_swap_interval (int interval=-1)
 Sets the swap interval to be used for the window.
void set_allow_resize (bool allow_resize)
 Sets if windows should be resizable.
void set_bpp (int bpp)
 Sets the number of bytes per pixel.
void set_refresh_rate (int refresh_rate)
 Set the refresh rate of the displaymode.
void set_tablet_context (bool create)
 Sets to true if a tablet input context should be created for this window.
void set_using_gui_window_cache (bool value)
 Uses a window from the window cache (GUI Only).
void set_layered (bool layered)
 Creates a layered window (complex shaped window).
void set_data (const CL_String &data_name, const CL_SharedPtr< CL_DisplayWindowDescriptionData > &ptr)
 Store object in description.
void set_depth_size (int value)
 Sets the minimum required depth buffer.
void set_stencil_size (int value)
 Sets the minimum required stencil buffer.

Detailed Description

Display window description class.

This class allows you to setup a more advanced description when creating a display window.


Constructor & Destructor Documentation

CL_DisplayWindowDescription::CL_DisplayWindowDescription (  ) 

Constructs a window description with default values.

CL_DisplayWindowDescription::CL_DisplayWindowDescription ( const CL_String title  ) 

Constructs a window description with default values and a title.

CL_DisplayWindowDescription::CL_DisplayWindowDescription ( const CL_String title,
const CL_Rect position,
bool  client_area 
)

Constructs a window description with default values, a title and a position.

CL_DisplayWindowDescription::CL_DisplayWindowDescription ( const CL_String title,
const CL_Size size,
bool  client_area 
)

Constructs a window description with default values, a title and a size.

CL_DisplayWindowDescription::CL_DisplayWindowDescription ( const CL_Rect position,
bool  client_area 
)

Constructs a window description with default values and a position.

CL_DisplayWindowDescription::CL_DisplayWindowDescription ( const CL_DisplayWindowDescription copy  ) 

Constructs a DisplayWindowDescription.

Parameters:
copy = Display Window Description
virtual CL_DisplayWindowDescription::~CL_DisplayWindowDescription (  )  [virtual]

Member Function Documentation

bool CL_DisplayWindowDescription::get_allow_resize (  )  const

Returns true if window should be resizeable.

int CL_DisplayWindowDescription::get_bpp (  )  const

Returns the numbers of bytes per pixel in the window.

CL_SharedPtr<CL_DisplayWindowDescriptionData> CL_DisplayWindowDescription::get_data ( const CL_String data_name  )  const

Returns the object stored in the given data name.

bool CL_DisplayWindowDescription::get_decorations (  )  const

Returns true if the window shall be created with decorations.

int CL_DisplayWindowDescription::get_depth_size (  )  const

Returns the minimum required depth buffer.

int CL_DisplayWindowDescription::get_flipping_buffers (  )  const

Returns the amount of flipping buffers to be created.

int CL_DisplayWindowDescription::get_fullscreen_monitor (  )  const

Returns the index of the monitor to go fullscreen on. See CL_ScreenInfo.

CL_DisplayWindow CL_DisplayWindowDescription::get_owner (  )  const

Returns the window owning this one.

CL_Rect CL_DisplayWindowDescription::get_position (  )  const

Returns the initial position of the window.

bool CL_DisplayWindowDescription::get_position_client_area (  )  const

Returns if the client area is used for the initial position of the window.

int CL_DisplayWindowDescription::get_refresh_rate (  )  const

Returns the refresh rate of the displaymode.

Specifies the frequency, in hertz (cycles per second). This value is also known as the vertical refresh rate.

CL_Size CL_DisplayWindowDescription::get_size (  )  const

Returns the size of the window stored in description.

int CL_DisplayWindowDescription::get_stencil_size (  )  const

Returns the minimum required stencil buffer.

int CL_DisplayWindowDescription::get_swap_interval (  )  const

Returns the swap interval to be used for the window.

bool CL_DisplayWindowDescription::get_tablet_context (  )  const

Returns true if a tablet context is to be created for the window.

const CL_String& CL_DisplayWindowDescription::get_title (  )  const

Returns the window title stored in the description.

bool CL_DisplayWindowDescription::get_using_gui_window_cache (  )  const

Returns true if window from the window cache should be used. (GUI Only).

This setting is ignored unless the GUI and CL_GUIWindowManagerSystem are used.

bool CL_DisplayWindowDescription::has_border (  )  const

Returns true if the window has a border.

bool CL_DisplayWindowDescription::has_caption (  )  const

Returns true if a title bar is shown.

bool CL_DisplayWindowDescription::has_drop_shadow (  )  const

Returns true if the window is drawn with a drop shadow effect.

bool CL_DisplayWindowDescription::has_maximize_button (  )  const

Returns true if the window has a maximize button.

bool CL_DisplayWindowDescription::has_minimize_button (  )  const

Returns true if the window has a minimize button.

bool CL_DisplayWindowDescription::has_sysmenu (  )  const

Returns true if the window has a window menu on its title bar.

bool CL_DisplayWindowDescription::is_dialog (  )  const

Returns true if the window is a dialog window.

bool CL_DisplayWindowDescription::is_fullscreen (  )  const

Returns if window should be initially fullscreen.

bool CL_DisplayWindowDescription::is_layered (  )  const

Returns true if window is layered (black is transparent).

bool CL_DisplayWindowDescription::is_tool_window (  )  const

Returns true if the window is a tool window.

bool CL_DisplayWindowDescription::is_topmost (  )  const

Returns true if the window should be placed above all non-topmost windows.

bool CL_DisplayWindowDescription::is_visible (  )  const

Returns true if the window is initially visible.

CL_DisplayWindowDescription& CL_DisplayWindowDescription::operator= ( const CL_DisplayWindowDescription copy  ) 

Copy assignment operator.

void CL_DisplayWindowDescription::set_allow_resize ( bool  allow_resize  ) 

Sets if windows should be resizable.

void CL_DisplayWindowDescription::set_bpp ( int  bpp  ) 

Sets the number of bytes per pixel.

void CL_DisplayWindowDescription::set_data ( const CL_String data_name,
const CL_SharedPtr< CL_DisplayWindowDescriptionData > &  ptr 
)

Store object in description.

void CL_DisplayWindowDescription::set_decorations ( bool  decorations  ) 

Sets if windows should have decorations.

This is identical to show_caption()

void CL_DisplayWindowDescription::set_depth_size ( int  value  ) 

Sets the minimum required depth buffer.

If this value is zero, the smallest available depth buffer is preferred. Otherwise, the largest available depth buffer of at least the minimum size is preferred.

void CL_DisplayWindowDescription::set_dialog_window ( bool  value = true  ) 

Flags the window to be a dialog window to the windowing system.

void CL_DisplayWindowDescription::set_drop_shadow ( bool  value = true  ) 

Enables a drop shadow effect on the window.

void CL_DisplayWindowDescription::set_flipping_buffers ( int  num_buffers = 2  ) 

Sets the amount of flipping buffers to be used.

void CL_DisplayWindowDescription::set_fullscreen ( bool  fullscreen = true,
int  monitor = 0 
)

Makes the window initially fullscreen.

void CL_DisplayWindowDescription::set_layered ( bool  layered  ) 

Creates a layered window (complex shaped window).

void CL_DisplayWindowDescription::set_owner_window ( const CL_DisplayWindow owner  ) 

Specifies another window which owns this one.

void CL_DisplayWindowDescription::set_position ( const CL_Rect position,
bool  client_area 
)

Sets the position of the window (including window frame).

The default position, is centred on the screen. If this is wanted, use set_size() instead

Parameters:
position = Window position
client_area = false = include the window frame. true = exclude the window frame
void CL_DisplayWindowDescription::set_refresh_rate ( int  refresh_rate  ) 

Set the refresh rate of the displaymode.

Specifies the frequency, in hertz (cycles per second). This value is also known as the vertical refresh rate.

void CL_DisplayWindowDescription::set_size ( const CL_Size size,
bool  client_area 
)

Sets the size of the window (including window frame).

Parameters:
size = Window size
client_area = false = include the window frame. true = exclude the window frame
void CL_DisplayWindowDescription::set_stencil_size ( int  value  ) 

Sets the minimum required stencil buffer.

If this value is zero, the smallest available stencil buffer is preferred. Otherwise, the largest available stencil buffer of at least the minimum size is preferred.

void CL_DisplayWindowDescription::set_swap_interval ( int  interval = -1  ) 

Sets the swap interval to be used for the window.

void CL_DisplayWindowDescription::set_tablet_context ( bool  create  ) 

Sets to true if a tablet input context should be created for this window.

void CL_DisplayWindowDescription::set_title ( const CL_String title  ) 

Sets the title of the window.

void CL_DisplayWindowDescription::set_tool_window ( bool  value = true  ) 

Flags the window to be a tool window to the windowing system.

void CL_DisplayWindowDescription::set_topmost ( bool  value = true  ) 

Sets if the window should be placed above all non-topmost windows.

void CL_DisplayWindowDescription::set_using_gui_window_cache ( bool  value  ) 

Uses a window from the window cache (GUI Only).

Creating a window in Windows XP is slow (about 100 ms). Use cached windows for menus and dialogs to avoid sluggish operation in XP. This setting is ignored unless the GUI and CL_GUIWindowManagerSystem are used.

void CL_DisplayWindowDescription::set_visible ( bool  value = true  ) 

Toggles whether the window is created as initially visible.

void CL_DisplayWindowDescription::show_border ( bool  value = true  ) 

Sets if the window has a border. DO NOT USE (This function is not implemented and is to be removed in ClanLib 2.4).

void CL_DisplayWindowDescription::show_caption ( bool  value = true  ) 

Controls if a title bar is shown or not.

void CL_DisplayWindowDescription::show_maximize_button ( bool  value = true  ) 

Sets if the window has a maximize button.

void CL_DisplayWindowDescription::show_minimize_button ( bool  value = true  ) 

Sets if the window has a minimize button.

void CL_DisplayWindowDescription::show_sysmenu ( bool  value = true  ) 

Sets if the window has a window menu on its title bar.


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