WindowProperties

Inheritance:

Methods of WindowProperties:

Constants in WindowProperties:

WindowProperties
WindowProperties::WindowProperties(void);

Description:

addProperties
void WindowProperties::add_properties(WindowProperties const &other);

Description: Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

clear
void WindowProperties::clear(void);

Description: Unsets all properties that have been specified so far, and resets the WindowProperties structure to its initial empty state.

clearCursorFilename
void WindowProperties::clear_cursor_filename(void);

Description: Removes the cursor_filename specification from the properties.

clearCursorHidden
void WindowProperties::clear_cursor_hidden(void);

Description: Removes the cursor_hidden specification from the properties.

clearFixedSize
void WindowProperties::clear_fixed_size(void);

Description: Removes the fixed_size specification from the properties.

clearForeground
void WindowProperties::clear_foreground(void);

Description: Removes the foreground specification from the properties.

clearFullscreen
void WindowProperties::clear_fullscreen(void);

Description: Removes the fullscreen specification from the properties.

clearIconFilename
void WindowProperties::clear_icon_filename(void);

Description: Removes the icon_filename specification from the properties.

clearMinimized
void WindowProperties::clear_minimized(void);

Description: Removes the minimized specification from the properties.

clearMouseMode
void WindowProperties::clear_mouse_mode(void);

Description: Removes the z_order specification from the properties.

clearOpen
void WindowProperties::clear_open(void);

Description: Removes the open specification from the properties.

clearOrigin
void WindowProperties::clear_origin(void);

Description: Removes the origin specification from the properties.

clearParentWindow
void WindowProperties::clear_parent_window(void);

Description: Removes the S_parent_window specification from the properties.

clearRawMice
void WindowProperties::clear_raw_mice(void);

Description: Removes the raw_mice specification from the properties.

clearSize
void WindowProperties::clear_size(void);

Description: Removes the size specification from the properties.

clearTitle
void WindowProperties::clear_title(void);

Description: Removes the title specification from the properties.

clearUndecorated
void WindowProperties::clear_undecorated(void);

Description: Removes the undecorated specification from the properties.

clearZOrder
void WindowProperties::clear_z_order(void);

Description: Removes the z_order specification from the properties.

getCursorFilename
Filename const &WindowProperties::get_cursor_filename(void) const;

Description: Returns the icon filename associated with the mouse cursor.

getCursorHidden
bool WindowProperties::get_cursor_hidden(void) const;

Description: Returns true if the mouse cursor is invisible.

getDefault
static WindowProperties WindowProperties::get_default(void);

Description: Returns a WindowProperties structure with all of the default values filled in according to the user's config file.

getFixedSize
bool WindowProperties::get_fixed_size(void) const;

Description: Returns true if the window cannot be resized by the user, false otherwise.

getForeground
bool WindowProperties::get_foreground(void) const;

Description: Returns true if the window is in the foreground.

getFullscreen
bool WindowProperties::get_fullscreen(void) const;

Description: Returns true if the window is in fullscreen mode.

getIconFilename
Filename const &WindowProperties::get_icon_filename(void) const;

Description: Returns the icon filename associated with the window.

getMinimized
bool WindowProperties::get_minimized(void) const;

Description: Returns true if the window is minimized.

getMouseMode
WindowProperties::MouseMode WindowProperties::get_mouse_mode(void) const;

Description: Removes the z_order specification from the properties.

getOpen
bool WindowProperties::get_open(void) const;

Description: Returns true if the window is open.

getParentWindow
unsigned int WindowProperties::get_parent_window(void) const;

Description: Removes the parent Window

getRawMice
bool WindowProperties::get_raw_mice(void) const;

Description: Returns true if the window reads the raw mice.

getTitle
string const &WindowProperties::get_title(void) const;

Description: Returns the window's title.

getUndecorated
bool WindowProperties::get_undecorated(void) const;

Description: Returns true if the window has no border.

getXOrigin
int WindowProperties::get_x_origin(void) const;

Description: Returns the x coordinate of the window's top-left corner, not including decorations.

getXSize
int WindowProperties::get_x_size(void) const;

Description: Returns size in pixels in the x dimension of the useful part of the window, not including decorations. That is, this is the window's width.

getYOrigin
int WindowProperties::get_y_origin(void) const;

Description: Returns the y coordinate of the window's top-left corner, not including decorations.

getYSize
int WindowProperties::get_y_size(void) const;

Description: Returns size in pixels in the y dimension of the useful part of the window, not including decorations. That is, this is the window's height.

getZOrder
WindowProperties::ZOrder WindowProperties::get_z_order(void) const;

Description: Returns the window's z_order.

hasCursorFilename
bool WindowProperties::has_cursor_filename(void) const;

Description: Returns true if set_cursor_filename() has been specified.

hasCursorHidden
bool WindowProperties::has_cursor_hidden(void) const;

Description: Returns true if set_cursor_hidden() has been specified.

hasFixedSize
bool WindowProperties::has_fixed_size(void) const;

Description: Returns true if set_fixed_size() has been specified.

hasForeground
bool WindowProperties::has_foreground(void) const;

Description: Returns true if set_foreground() has been specified.

hasFullscreen
bool WindowProperties::has_fullscreen(void) const;

Description: Returns true if set_fullscreen() has been specified.

hasIconFilename
bool WindowProperties::has_icon_filename(void) const;

Description: Returns true if set_icon_filename() has been specified.

hasMinimized
bool WindowProperties::has_minimized(void) const;

Description: Returns true if set_minimized() has been specified.

hasMouseMode
bool WindowProperties::has_mouse_mode(void) const;

Description: Removes the z_order specification from the properties.

hasOpen
bool WindowProperties::has_open(void) const;

Description: Returns true if set_open() has been specified.

hasOrigin
bool WindowProperties::has_origin(void) const;

Description: Returns true if the window origin has been specified, false otherwise.

hasParentWindow
bool WindowProperties::has_parent_window(void) const;

Description: Checks the S_parent_window specification from the properties.

hasRawMice
bool WindowProperties::has_raw_mice(void) const;

Description: Returns true if set_raw_mice() has been specified.

hasSize
bool WindowProperties::has_size(void) const;

Description: Returns true if the window size has been specified, false otherwise.

hasTitle
bool WindowProperties::has_title(void) const;

Description: Returns true if the window title has been specified, false otherwise.

hasUndecorated
bool WindowProperties::has_undecorated(void) const;

Description: Returns true if set_undecorated() has been specified.

hasZOrder
bool WindowProperties::has_z_order(void) const;

Description: Returns true if the window z_order has been specified, false otherwise.

isAnySpecified
bool WindowProperties::is_any_specified(void) const;

Description: Returns true if any properties have been specified, false otherwise.

operator !=
bool WindowProperties::operator !=(WindowProperties const &other) const;

Description:

operator =
void WindowProperties::operator =(WindowProperties const &copy);

Description:

operator ==
bool WindowProperties::operator ==(WindowProperties const &other) const;

Description:

output
void WindowProperties::output(ostream &out) const;

Description: Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

setCursorFilename
void WindowProperties::set_cursor_filename(Filename const &cursor_filename);

Description: Specifies the file that contains the icon to associate with the mouse cursor when it is within the window (and visible).

setCursorHidden
void WindowProperties::set_cursor_hidden(bool cursor_hidden);

Description: Specifies whether the mouse cursor should be visible.

setFixedSize
void WindowProperties::set_fixed_size(bool fixed_size);

Description: Specifies whether the window should be resizable by the user.

setForeground
void WindowProperties::set_foreground(bool foreground);

Description: Specifies whether the window should be opened in the foreground (true), or left in the background (false).

setFullscreen
void WindowProperties::set_fullscreen(bool fullscreen);

Description: Specifies whether the window should be opened in fullscreen mode (true) or normal windowed mode (false, the default).

setIconFilename
void WindowProperties::set_icon_filename(Filename const &icon_filename);

Description: Specifies the file that contains the icon to associate with the window when it is minimized.

setMinimized
void WindowProperties::set_minimized(bool minimized);

Description: Specifies whether the window should be created minimized (true), or normal (false).

setMouseMode
void WindowProperties::set_mouse_mode(WindowProperties::MouseMode mode);

Description: Removes the z_order specification from the properties.

setOpen
void WindowProperties::set_open(bool open);

Description: Specifies whether the window should be open. It is legal to create a GraphicsWindow in the closed state, and later request it to open by changing this flag.

setOrigin
void WindowProperties::set_origin(int x_origin, int y_origin);

Description: Specifies the origin on the screen (in pixels, relative to the top-left corner) at which the window should appear. This is the origin of the top-left corner of the useful part of the window, not including decorations.

setParentWindow
void WindowProperties::set_parent_window(unsigned int parent);

Description: Removes the z_order specification from the properties.

setRawMice
void WindowProperties::set_raw_mice(bool raw_mice);

Description: Specifies whether the window should read the raw mouse devices.

setSize
void WindowProperties::set_size(int x_size, int y_size);

Description: Specifies the requested size of the window, in pixels. This is the size of the useful part of the window, not including decorations.

setTitle
void WindowProperties::set_title(string const &title);

Description: Specifies the title that should be assigned to the window.

setUndecorated
void WindowProperties::set_undecorated(bool undecorated);

Description: Specifies whether the window should be created with a visible title and border (false, the default) or not (true).

setZOrder
void WindowProperties::set_z_order(WindowProperties::ZOrder z_order);

Description: Specifies the relative ordering of the window with respect to other windows. If the z_order is Z_top, the window will always be on top of other windows; if it is Z_bottom, it will always be below other windows. Most windows will want to be Z_normal, which allows the user to control the order.

size
static WindowProperties WindowProperties::size(int x_size, int y_size);

Description: Returns a WindowProperties structure with only the size specified. The size is the only property that matters to buffers.