All Classes |Grouped Classes |Index

Class CL_DisplayWindowDescription

Display window description class. More...

Derived from:

None

Derived by:

CL_GL1WindowDescription, CL_OpenGLWindowDescription

Group:

Window (Display)

#include <ClanLib/display.h>

Class Members:

Construction:

CL_DisplayWindowDescription

Constructs a window description with default values.


Attributes:

get_title

Returns the window title stored in the description.

get_decorations

Returns true if the window shall be created with decorations.

get_size

Returns the size of the window stored in description.

get_position

Returns the initial position of the window.

get_position_client_area

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

is_fullscreen

Returns if window should be initially fullscreen.

get_flipping_buffers

Returns the amount of flipping buffers to be created.

get_swap_interval

Returns the swap interval to be used for the window.

get_allow_resize

Returns true if window should be resizeable.

get_bpp

Returns the numbers of bytes per pixel in the window.

get_refresh_rate

Returns the refresh rate of the displaymode.

is_layered

Returns true if window is layered (black is transparent)

has_caption

Returns true if a title bar is shown.

has_sysmenu

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

has_minimize_button

Returns true if the window has a minimize button.

has_maximize_button

Returns true if the window has a maximize button.

has_border

Returns true if the window has a border.

is_tool_window

Returns true if the window is a tool window.

is_dialog

Returns true if the window is a dialog window.

is_visible

Returns true if the window is initially visible.

is_topmost

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

get_using_gui_window_cache

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

has_drop_shadow

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

get_owner

Returns the window owning this one.

get_tablet_context

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

get_data

Returns the object stored in the given data name.

get_depth_size

Returns the minimum required depth buffer.

get_stencil_size

Returns the minimum required stencil buffer.

get_fullscreen_monitor

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


Operations:

show_caption

Controls if a title bar is shown or not.

show_sysmenu

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

show_minimize_button

Sets if the window has a minimize button.

show_maximize_button

Sets if the window has a maximize button.

show_border

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

set_decorations

Sets if windows should have decorations.

set_visible

Toggles whether the window is created as initially visible.

set_topmost

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

set_tool_window

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

set_dialog_window

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

set_drop_shadow

Enables a drop shadow effect on the window.

set_owner_window

Specifies another window which owns this one.

set_title

Sets the title of the window.

set_size

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

set_position

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

set_fullscreen

Makes the window initially fullscreen.

set_flipping_buffers

Sets the amount of flipping buffers to be used.

set_swap_interval

Sets the swap interval to be used for the window.

set_allow_resize

Sets if windows should be resizable.

set_bpp

Sets the number of bytes per pixel.

set_refresh_rate

Set the refresh rate of the displaymode.

set_tablet_context

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

set_using_gui_window_cache

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

set_layered

Creates a layered window (complex shaped window)

set_data

Store object in description.

set_depth_size

Sets the minimum required depth buffer.

set_stencil_size

Sets the minimum required stencil buffer.

Detailed description:

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