ClanLib
2.3.7
|
Display window description class. More...
#include <display_window_description.h>
Public Member Functions | |
Construction | |
CL_DisplayWindowDescription () | |
Constructs a window description with default values. More... | |
CL_DisplayWindowDescription (const CL_String &title) | |
Constructs a window description with default values and a title. More... | |
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. More... | |
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. More... | |
CL_DisplayWindowDescription (const CL_Rect &position, bool client_area) | |
Constructs a window description with default values and a position. More... | |
CL_DisplayWindowDescription (const CL_DisplayWindowDescription ©) | |
Constructs a DisplayWindowDescription. More... | |
virtual | ~CL_DisplayWindowDescription () |
Attributes | |
const CL_String & | get_title () const |
Returns the window title stored in the description. More... | |
bool | get_decorations () const |
Returns true if the window shall be created with decorations. More... | |
CL_Size | get_size () const |
Returns the size of the window stored in description. More... | |
CL_Rect | get_position () const |
Returns the initial position of the window. More... | |
bool | get_position_client_area () const |
Returns if the client area is used for the initial position of the window. More... | |
bool | is_fullscreen () const |
Returns if window should be initially fullscreen. More... | |
int | get_flipping_buffers () const |
Returns the amount of flipping buffers to be created. More... | |
int | get_swap_interval () const |
Returns the swap interval to be used for the window. More... | |
bool | get_allow_resize () const |
Returns true if window should be resizeable. More... | |
int | get_bpp () const |
Returns the numbers of bytes per pixel in the window. More... | |
int | get_refresh_rate () const |
Returns the refresh rate of the displaymode. More... | |
bool | is_layered () const |
Returns true if window is layered (black is transparent) More... | |
bool | has_caption () const |
Returns true if a title bar is shown. More... | |
bool | has_sysmenu () const |
Returns true if the window has a window menu on its title bar. More... | |
bool | has_minimize_button () const |
Returns true if the window has a minimize button. More... | |
bool | has_maximize_button () const |
Returns true if the window has a maximize button. More... | |
bool | has_border () const |
Returns true if the window has a border. More... | |
bool | is_tool_window () const |
Returns true if the window is a tool window. More... | |
bool | is_dialog () const |
Returns true if the window is a dialog window. More... | |
bool | is_visible () const |
Returns true if the window is initially visible. More... | |
bool | is_topmost () const |
Returns true if the window should be placed above all non-topmost windows. More... | |
bool | get_using_gui_window_cache () const |
Returns true if window from the window cache should be used. (GUI Only) More... | |
bool | has_drop_shadow () const |
Returns true if the window is drawn with a drop shadow effect. More... | |
CL_DisplayWindow | get_owner () const |
Returns the window owning this one. More... | |
bool | get_tablet_context () const |
Returns true if a tablet context is to be created for the window. More... | |
CL_SharedPtr < CL_DisplayWindowDescriptionData > | get_data (const CL_String &data_name) const |
Returns the object stored in the given data name. More... | |
int | get_depth_size () const |
Returns the minimum required depth buffer. More... | |
int | get_stencil_size () const |
Returns the minimum required stencil buffer. More... | |
int | get_fullscreen_monitor () const |
Returns the index of the monitor to go fullscreen on. See CL_ScreenInfo. More... | |
Operations | |
CL_DisplayWindowDescription & | operator= (const CL_DisplayWindowDescription ©) |
Copy assignment operator. More... | |
void | show_caption (bool value=true) |
Controls if a title bar is shown or not. More... | |
void | show_sysmenu (bool value=true) |
Sets if the window has a window menu on its title bar. More... | |
void | show_minimize_button (bool value=true) |
Sets if the window has a minimize button. More... | |
void | show_maximize_button (bool value=true) |
Sets if the window has a maximize button. More... | |
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) More... | |
void | set_decorations (bool decorations) |
Sets if windows should have decorations. More... | |
void | set_visible (bool value=true) |
Toggles whether the window is created as initially visible. More... | |
void | set_topmost (bool value=true) |
Sets if the window should be placed above all non-topmost windows. More... | |
void | set_tool_window (bool value=true) |
Flags the window to be a tool window to the windowing system. More... | |
void | set_dialog_window (bool value=true) |
Flags the window to be a dialog window to the windowing system. More... | |
void | set_drop_shadow (bool value=true) |
Enables a drop shadow effect on the window. More... | |
void | set_owner_window (const CL_DisplayWindow &owner) |
Specifies another window which owns this one. More... | |
void | set_title (const CL_String &title) |
Sets the title of the window. More... | |
void | set_size (const CL_Size &size, bool client_area) |
Sets the size of the window (including window frame). More... | |
void | set_position (const CL_Rect &position, bool client_area) |
Sets the position of the window (including window frame). More... | |
void | set_fullscreen (bool fullscreen=true, int monitor=0) |
Makes the window initially fullscreen. More... | |
void | set_flipping_buffers (int num_buffers=2) |
Sets the amount of flipping buffers to be used. More... | |
void | set_swap_interval (int interval=-1) |
Sets the swap interval to be used for the window. More... | |
void | set_allow_resize (bool allow_resize) |
Sets if windows should be resizable. More... | |
void | set_bpp (int bpp) |
Sets the number of bytes per pixel. More... | |
void | set_refresh_rate (int refresh_rate) |
Set the refresh rate of the displaymode. More... | |
void | set_tablet_context (bool create) |
Sets to true if a tablet input context should be created for this window. More... | |
void | set_using_gui_window_cache (bool value) |
Uses a window from the window cache (GUI Only). More... | |
void | set_layered (bool layered) |
Creates a layered window (complex shaped window) More... | |
void | set_data (const CL_String &data_name, const CL_SharedPtr< CL_DisplayWindowDescriptionData > &ptr) |
Store object in description. More... | |
void | set_depth_size (int value) |
Sets the minimum required depth buffer. More... | |
void | set_stencil_size (int value) |
Sets the minimum required stencil buffer. More... | |
Display window description class.
This class allows you to setup a more advanced description when creating a display window.
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.
copy | = Display Window Description |
|
virtual |
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
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).
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.