clan::DisplayWindowDescription Class Reference

Display window description class. More...

#include <display_window_description.h>

Public Member Functions

 DisplayWindowDescription ()
 Constructs a window description with default values. More...
 
 DisplayWindowDescription (const std::string &title)
 Constructs a window description with default values and a title. More...
 
 DisplayWindowDescription (const std::string &title, const Rectf &position, bool client_area)
 Constructs a window description with default values, a title and a position. More...
 
 DisplayWindowDescription (const std::string &title, const Sizef &size, bool client_area)
 Constructs a window description with default values, a title and a size. More...
 
 DisplayWindowDescription (const Rectf &position, bool client_area)
 Constructs a window description with default values and a position. More...
 
 DisplayWindowDescription (const DisplayWindowDescription &copy)
 Constructs a DisplayWindowDescription. More...
 
 ~DisplayWindowDescription ()
 
bool get_allow_resize () const
 Returns true if window should be resizeable. More...
 
bool get_allow_screensaver () const
 Returns true if the screensaver is allowed. More...
 
int get_bpp () const
 Returns the numbers of bytes per pixel in the window. More...
 
int get_depth_size () const
 Returns the minimum required depth buffer. More...
 
int get_flipping_buffers () const
 Returns the amount of flipping buffers to be created. More...
 
int get_fullscreen_monitor () const
 Returns the index of the monitor to go fullscreen on. See ScreenInfo. More...
 
DisplayWindowHandle get_handle () const
 
int get_multisampling () const
 Returns the number of samples per pixel. More...
 
DisplayWindow get_owner () const
 Returns the window owning this one. More...
 
Rectf 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...
 
int get_refresh_rate () const
 
Sizef get_size () const
 Returns the size of the window stored in description. More...
 
int get_stencil_size () const
 Returns the minimum required stencil buffer. More...
 
int get_swap_interval () const
 Returns the swap interval to be used for the window. More...
 
const std::stringget_title () const
 Returns the window title stored in the description. More...
 
bool has_caption () const
 Returns true if a title bar is shown. More...
 
bool has_drop_shadow () const
 Returns true if the window is drawn with a drop shadow effect. More...
 
bool has_maximize_button () const
 Returns true if the window has a maximize button. More...
 
bool has_minimize_button () const
 Returns true if the window has a minimize button. More...
 
bool has_no_activate () const
 Indicates if window is automatically activated or not. More...
 
bool has_sysmenu () const
 Returns true if the window has a window menu on its title bar. More...
 
bool is_dialog () const
 Returns true if it is a dialog window. More...
 
bool is_fullscreen () const
 Returns if window should be initially fullscreen. More...
 
bool is_layered () const
 Returns true if window is layered (black is transparent) More...
 
bool is_main () const
 Returns true if it is a main window. More...
 
bool is_popup () const
 Returns true if it is a popup window. More...
 
bool is_topmost () const
 Returns true if the window should be placed above all non-topmost windows. More...
 
bool is_update_supported () const
 Returns true if DisplayWindow::update should be supported. More...
 
bool is_visible () const
 Returns true if the window is initially visible. More...
 
DisplayWindowDescriptionoperator= (const DisplayWindowDescription &copy)
 Copy assignment operator. More...
 
void set_allow_resize (bool allow_resize=true)
 Sets if windows should be resizable. More...
 
void set_allow_screensaver (bool allow_screensaver=true)
 Allow the screensaver to appear. More...
 
void set_bpp (int bpp)
 Sets the number of bytes per pixel. More...
 
void set_depth_size (int value)
 Sets the minimum required depth buffer. More...
 
void set_dialog_window ()
 Display the window as a modal dialog. More...
 
void set_drop_shadow (bool value=true)
 Enables a drop shadow effect on the window. More...
 
void set_flipping_buffers (int num_buffers=2)
 Sets the amount of flipping buffers to be used. More...
 
void set_fullscreen (bool fullscreen=true, int monitor=0)
 Makes the window initially fullscreen. More...
 
void set_handle (DisplayWindowHandle handle)
 
void set_layered (bool layered)
 Creates a layered window (complex shaped window) More...
 
void set_main_window ()
 Display this window as of the main windows of the application. More...
 
void set_multisampling (int value)
 Sets the number of samples per pixel. More...
 
void set_no_activate (bool value=true)
 Prevents window from being automatically activated. More...
 
void set_owner_window (const DisplayWindow &owner)
 Specifies another window which owns this one. More...
 
void set_popup_window ()
 Display the window as a popup. More...
 
void set_position (const Rectf &position, bool client_area)
 Sets the position of the window (including window frame). More...
 
void set_refresh_rate (int refresh_rate)
 
void set_size (const Sizef &size, bool client_area)
 Sets the size of the window (including window frame). More...
 
void set_stencil_size (int value)
 Sets the minimum required stencil buffer. More...
 
void set_swap_interval (int interval=-1)
 Sets the swap interval to be used for the window. More...
 
void set_title (const std::string &title)
 Sets the title of the window. More...
 
void set_topmost (bool value=true)
 Sets if the window should be placed above all non-topmost windows. More...
 
void set_update_supported (bool value) const
 Controls if DisplayWindow::update is supported. More...
 
void set_visible (bool value=true)
 Toggles whether the window is created as initially visible. More...
 
void show_caption (bool value=true)
 Controls if a title bar (including frame) is shown or not. More...
 
void show_maximize_button (bool value=true)
 Sets if the window has a maximize button. More...
 
void show_minimize_button (bool value=true)
 Sets if the window has a minimize button. More...
 
void show_sysmenu (bool value=true)
 Sets if the window has a window menu on its title bar. More...
 

Detailed Description

Display window description class.

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

Constructor & Destructor Documentation

clan::DisplayWindowDescription::DisplayWindowDescription ( )

Constructs a window description with default values.

clan::DisplayWindowDescription::DisplayWindowDescription ( const std::string title)

Constructs a window description with default values and a title.

clan::DisplayWindowDescription::DisplayWindowDescription ( const std::string title,
const Rectf position,
bool  client_area 
)

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

clan::DisplayWindowDescription::DisplayWindowDescription ( const std::string title,
const Sizef size,
bool  client_area 
)

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

clan::DisplayWindowDescription::DisplayWindowDescription ( const Rectf position,
bool  client_area 
)

Constructs a window description with default values and a position.

clan::DisplayWindowDescription::DisplayWindowDescription ( const DisplayWindowDescription copy)

Constructs a DisplayWindowDescription.

Parameters
copy= Display Window Description
clan::DisplayWindowDescription::~DisplayWindowDescription ( )

Member Function Documentation

bool clan::DisplayWindowDescription::get_allow_resize ( ) const

Returns true if window should be resizeable.

bool clan::DisplayWindowDescription::get_allow_screensaver ( ) const

Returns true if the screensaver is allowed.

int clan::DisplayWindowDescription::get_bpp ( ) const

Returns the numbers of bytes per pixel in the window.

int clan::DisplayWindowDescription::get_depth_size ( ) const

Returns the minimum required depth buffer.

int clan::DisplayWindowDescription::get_flipping_buffers ( ) const

Returns the amount of flipping buffers to be created.

int clan::DisplayWindowDescription::get_fullscreen_monitor ( ) const

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

DisplayWindowHandle clan::DisplayWindowDescription::get_handle ( ) const

Returns an platform-specific internal display window handle object.

int clan::DisplayWindowDescription::get_multisampling ( ) const

Returns the number of samples per pixel.

DisplayWindow clan::DisplayWindowDescription::get_owner ( ) const

Returns the window owning this one.

Rectf clan::DisplayWindowDescription::get_position ( ) const

Returns the initial position of the window.

bool clan::DisplayWindowDescription::get_position_client_area ( ) const

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

int clan::DisplayWindowDescription::get_refresh_rate ( ) const

Returns the refresh rate of the DisplayMode in Hertz (cycles per second). This value is also known as the vertical refresh rate.

Sizef clan::DisplayWindowDescription::get_size ( ) const

Returns the size of the window stored in description.

int clan::DisplayWindowDescription::get_stencil_size ( ) const

Returns the minimum required stencil buffer.

int clan::DisplayWindowDescription::get_swap_interval ( ) const

Returns the swap interval to be used for the window.

const std::string& clan::DisplayWindowDescription::get_title ( ) const

Returns the window title stored in the description.

bool clan::DisplayWindowDescription::has_caption ( ) const

Returns true if a title bar is shown.

bool clan::DisplayWindowDescription::has_drop_shadow ( ) const

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

bool clan::DisplayWindowDescription::has_maximize_button ( ) const

Returns true if the window has a maximize button.

bool clan::DisplayWindowDescription::has_minimize_button ( ) const

Returns true if the window has a minimize button.

bool clan::DisplayWindowDescription::has_no_activate ( ) const

Indicates if window is automatically activated or not.

bool clan::DisplayWindowDescription::has_sysmenu ( ) const

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

bool clan::DisplayWindowDescription::is_dialog ( ) const

Returns true if it is a dialog window.

bool clan::DisplayWindowDescription::is_fullscreen ( ) const

Returns if window should be initially fullscreen.

bool clan::DisplayWindowDescription::is_layered ( ) const

Returns true if window is layered (black is transparent)

bool clan::DisplayWindowDescription::is_main ( ) const

Returns true if it is a main window.

bool clan::DisplayWindowDescription::is_popup ( ) const

Returns true if it is a popup window.

bool clan::DisplayWindowDescription::is_topmost ( ) const

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

bool clan::DisplayWindowDescription::is_update_supported ( ) const

Returns true if DisplayWindow::update should be supported.

bool clan::DisplayWindowDescription::is_visible ( ) const

Returns true if the window is initially visible.

DisplayWindowDescription& clan::DisplayWindowDescription::operator= ( const DisplayWindowDescription copy)

Copy assignment operator.

void clan::DisplayWindowDescription::set_allow_resize ( bool  allow_resize = true)

Sets if windows should be resizable.

This is used for all window types (Main, Dialog and Popup)

void clan::DisplayWindowDescription::set_allow_screensaver ( bool  allow_screensaver = true)

Allow the screensaver to appear.

Parameters
allow_screensaver= Allow the allow_screensaver (default is true)
void clan::DisplayWindowDescription::set_bpp ( int  bpp)

Sets the number of bytes per pixel.

void clan::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 clan::DisplayWindowDescription::set_dialog_window ( )

Display the window as a modal dialog.

Window is shown on the taskbar

void clan::DisplayWindowDescription::set_drop_shadow ( bool  value = true)

Enables a drop shadow effect on the window.

void clan::DisplayWindowDescription::set_flipping_buffers ( int  num_buffers = 2)

Sets the amount of flipping buffers to be used.

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

Makes the window initially fullscreen.

void clan::DisplayWindowDescription::set_handle ( DisplayWindowHandle  handle)

Sets the platform-specific internal display window handle object.

void clan::DisplayWindowDescription::set_layered ( bool  layered)

Creates a layered window (complex shaped window)

Use with set_popup_window()

void clan::DisplayWindowDescription::set_main_window ( )

Display this window as of the main windows of the application.

Window is shown on the taskbar

void clan::DisplayWindowDescription::set_multisampling ( int  value)

Sets the number of samples per pixel.

void clan::DisplayWindowDescription::set_no_activate ( bool  value = true)

Prevents window from being automatically activated.

void clan::DisplayWindowDescription::set_owner_window ( const DisplayWindow owner)

Specifies another window which owns this one.

void clan::DisplayWindowDescription::set_popup_window ( )

Display the window as a popup.

This is treated as a transparent window (without clickthrough). If clickthrough is also required, use set_layered_window() as well

void clan::DisplayWindowDescription::set_position ( const Rectf 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 clan::DisplayWindowDescription::set_refresh_rate ( int  refresh_rate)

Sets the refresh rate of the DisplayMode in Hertz (cycles per second). This value is also known as the vertical refresh rate.

void clan::DisplayWindowDescription::set_size ( const Sizef 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 clan::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 clan::DisplayWindowDescription::set_swap_interval ( int  interval = -1)

Sets the swap interval to be used for the window.

void clan::DisplayWindowDescription::set_title ( const std::string title)

Sets the title of the window.

void clan::DisplayWindowDescription::set_topmost ( bool  value = true)

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

This is used for all window types (Main, Dialog and Popup)

void clan::DisplayWindowDescription::set_update_supported ( bool  value) const

Controls if DisplayWindow::update is supported.

The Direct3D target needs to know at window creation time if the application intends to update the screen by calling DisplayWindow::update.

void clan::DisplayWindowDescription::set_visible ( bool  value = true)

Toggles whether the window is created as initially visible.

void clan::DisplayWindowDescription::show_caption ( bool  value = true)

Controls if a title bar (including frame) is shown or not.

This is only used for the popup window types (Not Main and Dialog)

void clan::DisplayWindowDescription::show_maximize_button ( bool  value = true)

Sets if the window has a maximize button.

This is only used for the main and dialog window types (Not Popup)

void clan::DisplayWindowDescription::show_minimize_button ( bool  value = true)

Sets if the window has a minimize button.

This is only used for the main and dialog window types (Not Popup)

void clan::DisplayWindowDescription::show_sysmenu ( bool  value = true)

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

This is only used for the main window type (not Dialog and Popup)


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