Panda3D
|
A container for the various kinds of properties we might ask to have on a graphics window before we open it. More...
#include "windowProperties.h"
Public Types | |
enum | MouseMode { M_absolute, M_relative, M_confined } |
enum | ZOrder { Z_bottom, Z_normal, Z_top } |
Public Member Functions | |
WindowProperties (const WindowProperties ©) | |
void | add_properties (const WindowProperties &other) |
Sets any properties that are explicitly specified in other on this object. More... | |
void | clear () |
Unsets all properties that have been specified so far, and resets the WindowProperties structure to its initial empty state. More... | |
void | clear_cursor_filename () |
Removes the cursor_filename specification from the properties. More... | |
void | clear_cursor_hidden () |
Removes the cursor_hidden specification from the properties. More... | |
void | clear_fixed_size () |
Removes the fixed_size specification from the properties. More... | |
void | clear_foreground () |
Removes the foreground specification from the properties. More... | |
void | clear_fullscreen () |
Removes the fullscreen specification from the properties. More... | |
void | clear_icon_filename () |
Removes the icon_filename specification from the properties. More... | |
void | clear_minimized () |
Removes the minimized specification from the properties. More... | |
void | clear_mouse_mode () |
Removes the mouse_mode specification from the properties. More... | |
void | clear_open () |
Removes the open specification from the properties. More... | |
void | clear_origin () |
Removes the origin specification from the properties. More... | |
void | clear_parent_window () |
Removes the S_parent_window specification from the properties. More... | |
void | clear_raw_mice () |
Removes the raw_mice specification from the properties. More... | |
void | clear_size () |
Removes the size specification from the properties. More... | |
void | clear_title () |
Removes the title specification from the properties. More... | |
void | clear_undecorated () |
Removes the undecorated specification from the properties. More... | |
void | clear_z_order () |
Removes the z_order specification from the properties. More... | |
const Filename & | get_cursor_filename () const |
Returns the icon filename associated with the mouse cursor. More... | |
bool | get_cursor_hidden () const |
Returns true if the mouse cursor is invisible. More... | |
bool | get_fixed_size () const |
Returns true if the window cannot be resized by the user, false otherwise. More... | |
bool | get_foreground () const |
Returns true if the window is in the foreground. More... | |
bool | get_fullscreen () const |
Returns true if the window is in fullscreen mode. More... | |
const Filename & | get_icon_filename () const |
Returns the icon filename associated with the window. More... | |
bool | get_minimized () const |
Returns true if the window is minimized. More... | |
MouseMode | get_mouse_mode () const |
See set_mouse_mode(). More... | |
bool | get_open () const |
Returns true if the window is open. More... | |
const LPoint2i & | get_origin () const |
Returns the coordinates of the window's top-left corner, not including decorations. More... | |
WindowHandle * | get_parent_window () const |
Returns the parent window specification, or NULL if there is no parent window specified. More... | |
bool | get_raw_mice () const |
Returns true if the window reads the raw mice. More... | |
const LVector2i & | get_size () const |
Returns size in pixels of the useful part of the window, not including decorations. More... | |
const string & | get_title () const |
Returns the window's title. More... | |
bool | get_undecorated () const |
Returns true if the window has no border. More... | |
int | get_x_origin () const |
Returns the x coordinate of the window's top-left corner, not including decorations. More... | |
int | get_x_size () const |
Returns size in pixels in the x dimension of the useful part of the window, not including decorations. More... | |
int | get_y_origin () const |
Returns the y coordinate of the window's top-left corner, not including decorations. More... | |
int | get_y_size () const |
Returns size in pixels in the y dimension of the useful part of the window, not including decorations. More... | |
ZOrder | get_z_order () const |
Returns the window's z_order. More... | |
bool | has_cursor_filename () const |
Returns true if set_cursor_filename() has been specified. More... | |
bool | has_cursor_hidden () const |
Returns true if set_cursor_hidden() has been specified. More... | |
bool | has_fixed_size () const |
Returns true if set_fixed_size() has been specified. More... | |
bool | has_foreground () const |
Returns true if set_foreground() has been specified. More... | |
bool | has_fullscreen () const |
Returns true if set_fullscreen() has been specified. More... | |
bool | has_icon_filename () const |
Returns true if set_icon_filename() has been specified. More... | |
bool | has_minimized () const |
Returns true if set_minimized() has been specified. More... | |
bool | has_mouse_mode () const |
bool | has_open () const |
Returns true if set_open() has been specified. More... | |
bool | has_origin () const |
Returns true if the window origin has been specified, false otherwise. More... | |
bool | has_parent_window () const |
Checks the S_parent_window specification from the properties. More... | |
bool | has_raw_mice () const |
Returns true if set_raw_mice() has been specified. More... | |
bool | has_size () const |
Returns true if the window size has been specified, false otherwise. More... | |
bool | has_title () const |
Returns true if the window title has been specified, false otherwise. More... | |
bool | has_undecorated () const |
Returns true if set_undecorated() has been specified. More... | |
bool | has_z_order () const |
Returns true if the window z_order has been specified, false otherwise. More... | |
bool | is_any_specified () const |
Returns true if any properties have been specified, false otherwise. More... | |
bool | operator!= (const WindowProperties &other) const |
void | operator= (const WindowProperties ©) |
bool | operator== (const WindowProperties &other) const |
void | output (ostream &out) const |
Sets any properties that are explicitly specified in other on this object. More... | |
void | set_cursor_filename (const Filename &cursor_filename) |
Specifies the file that contains the icon to associate with the mouse cursor when it is within the window (and visible). More... | |
void | set_cursor_hidden (bool cursor_hidden) |
Specifies whether the mouse cursor should be visible. More... | |
void | set_fixed_size (bool fixed_size) |
Specifies whether the window should be resizable by the user. More... | |
void | set_foreground (bool foreground) |
Specifies whether the window should be opened in the foreground (true), or left in the background (false). More... | |
void | set_fullscreen (bool fullscreen) |
Specifies whether the window should be opened in fullscreen mode (true) or normal windowed mode (false, the default). More... | |
void | set_icon_filename (const Filename &icon_filename) |
Specifies the file that contains the icon to associate with the window when it is minimized. More... | |
void | set_minimized (bool minimized) |
Specifies whether the window should be created minimized (true), or normal (false). More... | |
void | set_mouse_mode (MouseMode mode) |
Specifies the mode in which the window is to operate its mouse pointer. More... | |
void | set_open (bool open) |
Specifies whether the window should be open. More... | |
void | set_origin (const LPoint2i &origin) |
Specifies the origin on the screen (in pixels, relative to the top-left corner) at which the window should appear. More... | |
void | set_origin (int x_origin, int y_origin) |
Specifies the origin on the screen (in pixels, relative to the top-left corner) at which the window should appear. More... | |
void | set_parent_window (size_t parent) |
Specifies the window that this window should be attached to. More... | |
void | set_parent_window (WindowHandle *parent_window=NULL) |
Specifies the window that this window should be attached to. More... | |
void | set_raw_mice (bool raw_mice) |
Specifies whether the window should read the raw mouse devices. More... | |
void | set_size (const LVector2i &size) |
Specifies the requested size of the window, in pixels. More... | |
void | set_size (int x_size, int y_size) |
Specifies the requested size of the window, in pixels. More... | |
void | set_title (const string &title) |
Specifies the title that should be assigned to the window. More... | |
void | set_undecorated (bool undecorated) |
Specifies whether the window should be created with a visible title and border (false, the default) or not (true). More... | |
void | set_z_order (ZOrder z_order) |
Specifies the relative ordering of the window with respect to other windows. More... | |
Static Public Member Functions | |
static void | clear_default () |
Returns the "default" WindowProperties to whatever is specified in the user's config file. More... | |
static WindowProperties | get_config_properties () |
Returns a WindowProperties structure with all of the default values filled in according to the user's config file. More... | |
static WindowProperties | get_default () |
Returns the "default" WindowProperties. More... | |
static void | set_default (const WindowProperties &default_properties) |
Replaces the "default" WindowProperties with the specified structure. More... | |
static WindowProperties | size (int x_size, int y_size) |
Returns a WindowProperties structure with only the size specified. More... | |
A container for the various kinds of properties we might ask to have on a graphics window before we open it.
This also serves to hold the current properties for a window after it has been opened.
Definition at line 32 of file windowProperties.h.
void WindowProperties::add_properties | ( | const WindowProperties & | other | ) |
Sets any properties that are explicitly specified in other on this object.
Leaves other properties unchanged.
Definition at line 239 of file windowProperties.cxx.
References get_cursor_filename(), get_cursor_hidden(), get_fixed_size(), get_foreground(), get_fullscreen(), get_icon_filename(), get_minimized(), get_mouse_mode(), get_open(), get_origin(), get_parent_window(), get_raw_mice(), get_size(), get_title(), get_undecorated(), get_z_order(), has_cursor_filename(), has_cursor_hidden(), has_fixed_size(), has_foreground(), has_fullscreen(), has_icon_filename(), has_minimized(), has_open(), has_origin(), has_parent_window(), has_raw_mice(), has_size(), has_title(), has_undecorated(), has_z_order(), output(), set_cursor_filename(), set_cursor_hidden(), set_fixed_size(), set_foreground(), set_fullscreen(), set_icon_filename(), set_minimized(), set_mouse_mode(), set_open(), set_origin(), set_parent_window(), set_raw_mice(), set_size(), set_title(), set_undecorated(), and set_z_order().
Referenced by PandaFramework::get_default_window_props(), GraphicsWindow::process_events(), set_parent_window(), eglGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
void WindowProperties::clear | ( | ) |
Unsets all properties that have been specified so far, and resets the WindowProperties structure to its initial empty state.
Definition at line 188 of file windowProperties.cxx.
References set_parent_window(), LPoint2i::zero(), and LVector2i::zero().
Referenced by GraphicsWindow::process_events(), GraphicsWindow::set_properties_now(), and size().
|
inline |
Removes the cursor_filename specification from the properties.
Definition at line 743 of file windowProperties.I.
References set_z_order().
Referenced by has_cursor_filename(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Removes the cursor_hidden specification from the properties.
Definition at line 650 of file windowProperties.I.
References set_icon_filename().
Referenced by has_cursor_hidden(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
static |
Returns the "default" WindowProperties to whatever is specified in the user's config file.
Definition at line 140 of file windowProperties.cxx.
References size().
Referenced by set_default().
|
inline |
Removes the fixed_size specification from the properties.
Definition at line 366 of file windowProperties.I.
References set_fullscreen().
Referenced by has_fixed_size(), and x11GraphicsWindow::set_properties_now().
|
inline |
Removes the foreground specification from the properties.
Definition at line 462 of file windowProperties.I.
References set_minimized().
Referenced by has_foreground(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Removes the fullscreen specification from the properties.
Definition at line 414 of file windowProperties.I.
References set_foreground().
Referenced by has_fullscreen(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Removes the icon_filename specification from the properties.
Definition at line 696 of file windowProperties.I.
References set_cursor_filename().
Referenced by has_icon_filename(), and WinGraphicsWindow::set_properties_now().
|
inline |
Removes the minimized specification from the properties.
Definition at line 509 of file windowProperties.I.
References set_raw_mice().
Referenced by has_minimized(), and WinGraphicsWindow::set_properties_now().
|
inline |
Removes the mouse_mode specification from the properties.
Definition at line 858 of file windowProperties.I.
References set_parent_window().
Referenced by get_mouse_mode(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Removes the open specification from the properties.
Definition at line 604 of file windowProperties.I.
References set_cursor_hidden().
Referenced by has_open(), and GraphicsWindow::set_properties_now().
|
inline |
Removes the origin specification from the properties.
Definition at line 139 of file windowProperties.I.
References set_size(), and LPoint2i::zero().
Referenced by has_origin(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Removes the S_parent_window specification from the properties.
Definition at line 914 of file windowProperties.I.
References output().
Referenced by has_parent_window().
|
inline |
Removes the raw_mice specification from the properties.
Definition at line 556 of file windowProperties.I.
References set_open().
Referenced by has_raw_mice().
|
inline |
Removes the size specification from the properties.
Definition at line 225 of file windowProperties.I.
References set_title(), and LVector2i::zero().
Referenced by has_size(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Removes the title specification from the properties.
Definition at line 270 of file windowProperties.I.
References set_undecorated().
Referenced by has_title(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Removes the undecorated specification from the properties.
Definition at line 318 of file windowProperties.I.
References set_fixed_size().
Referenced by has_undecorated().
|
inline |
Removes the z_order specification from the properties.
Definition at line 791 of file windowProperties.I.
References set_mouse_mode().
Referenced by has_z_order(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
static |
Returns a WindowProperties structure with all of the default values filled in according to the user's config file.
Definition at line 58 of file windowProperties.cxx.
References get_default(), ConfigVariable::get_num_words(), ConfigVariableInt::get_value(), set_cursor_filename(), set_cursor_hidden(), set_fixed_size(), set_fullscreen(), set_icon_filename(), set_mouse_mode(), set_open(), set_origin(), set_parent_window(), set_size(), set_title(), set_undecorated(), and set_z_order().
Referenced by get_default().
|
inline |
Returns the icon filename associated with the mouse cursor.
Definition at line 721 of file windowProperties.I.
References has_cursor_filename().
Referenced by add_properties(), output(), set_cursor_filename(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if the mouse cursor is invisible.
Definition at line 630 of file windowProperties.I.
References has_cursor_hidden().
Referenced by add_properties(), output(), set_cursor_hidden(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and WinGraphicsWindow::static_window_proc().
|
static |
Returns the "default" WindowProperties.
If set_default() has been called, this returns that WindowProperties structure; otherwise, this returns get_config_properties().
Definition at line 106 of file windowProperties.cxx.
References get_config_properties(), and set_default().
Referenced by get_config_properties(), and PandaFramework::get_default_window_props().
|
inline |
Returns true if the window cannot be resized by the user, false otherwise.
Definition at line 346 of file windowProperties.I.
References has_fixed_size().
Referenced by add_properties(), output(), set_fixed_size(), eglGraphicsWindow::set_properties_now(), and x11GraphicsWindow::set_properties_now().
|
inline |
Returns true if the window is in the foreground.
Definition at line 442 of file windowProperties.I.
References has_foreground().
Referenced by add_properties(), output(), set_foreground(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if the window is in fullscreen mode.
Definition at line 394 of file windowProperties.I.
References has_fullscreen().
Referenced by add_properties(), GraphicsWindow::is_fullscreen(), output(), set_fullscreen(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Returns the icon filename associated with the window.
Definition at line 674 of file windowProperties.I.
References has_icon_filename().
Referenced by add_properties(), WinGraphicsWindow::get_ime_hwnd(), output(), set_icon_filename(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if the window is minimized.
Definition at line 489 of file windowProperties.I.
References has_minimized().
Referenced by add_properties(), output(), set_minimized(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
See set_mouse_mode().
Definition at line 838 of file windowProperties.I.
References clear_mouse_mode().
Referenced by add_properties(), output(), set_mouse_mode(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Returns true if the window is open.
Definition at line 584 of file windowProperties.I.
References has_open().
Referenced by add_properties(), GraphicsWindow::is_closed(), output(), set_open(), and GraphicsWindow::set_properties_now().
|
inline |
Returns the coordinates of the window's top-left corner, not including decorations.
Definition at line 93 of file windowProperties.I.
References get_x_origin(), has_origin(), and LPoint2i::zero().
Referenced by add_properties(), and set_origin().
|
inline |
Returns the parent window specification, or NULL if there is no parent window specified.
Definition at line 894 of file windowProperties.I.
References has_parent_window().
Referenced by add_properties(), osxGraphicsPipe::create_cg_image(), output(), and set_parent_window().
|
inline |
Returns true if the window reads the raw mice.
Definition at line 536 of file windowProperties.I.
References has_raw_mice().
Referenced by add_properties(), output(), and set_raw_mice().
|
inline |
Returns size in pixels of the useful part of the window, not including decorations.
Definition at line 177 of file windowProperties.I.
References get_x_size(), has_size(), and LVector2i::zero().
Referenced by add_properties(), x11GraphicsWindow::set_properties_now(), and set_size().
|
inline |
Returns the window's title.
Definition at line 248 of file windowProperties.I.
References has_title().
Referenced by add_properties(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and set_title().
|
inline |
Returns true if the window has no border.
Definition at line 298 of file windowProperties.I.
References has_undecorated().
Referenced by add_properties(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and set_undecorated().
|
inline |
Returns the x coordinate of the window's top-left corner, not including decorations.
Definition at line 105 of file windowProperties.I.
References get_y_origin(), and has_origin().
Referenced by get_origin(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), WinGraphicsWindow::static_window_proc(), and wdxGraphicsWindow9::verify_window_sizes().
|
inline |
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.
Definition at line 190 of file windowProperties.I.
References get_y_size(), and has_size().
Referenced by get_size(), GraphicsEngine::make_output(), output(), eglGraphicsWindow::process_events(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), MouseAndKeyboard::set_source(), WinGraphicsWindow::static_window_proc(), and wdxGraphicsWindow9::verify_window_sizes().
|
inline |
Returns the y coordinate of the window's top-left corner, not including decorations.
Definition at line 117 of file windowProperties.I.
References has_origin().
Referenced by get_x_origin(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), WinGraphicsWindow::static_window_proc(), and wdxGraphicsWindow9::verify_window_sizes().
|
inline |
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.
Definition at line 203 of file windowProperties.I.
References has_size().
Referenced by get_x_size(), GraphicsEngine::make_output(), output(), eglGraphicsWindow::process_events(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), MouseAndKeyboard::set_source(), WinGraphicsWindow::static_window_proc(), and wdxGraphicsWindow9::verify_window_sizes().
|
inline |
Returns the window's z_order.
Definition at line 770 of file windowProperties.I.
References has_z_order().
Referenced by add_properties(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and set_z_order().
|
inline |
Returns true if set_cursor_filename() has been specified.
Definition at line 732 of file windowProperties.I.
References clear_cursor_filename().
Referenced by add_properties(), get_cursor_filename(), output(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_cursor_hidden() has been specified.
Definition at line 640 of file windowProperties.I.
References clear_cursor_hidden().
Referenced by add_properties(), get_cursor_hidden(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_fixed_size() has been specified.
Definition at line 356 of file windowProperties.I.
References clear_fixed_size().
Referenced by add_properties(), get_fixed_size(), output(), and x11GraphicsWindow::set_properties_now().
|
inline |
Returns true if set_foreground() has been specified.
Definition at line 452 of file windowProperties.I.
References clear_foreground().
Referenced by add_properties(), get_foreground(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_fullscreen() has been specified.
Definition at line 404 of file windowProperties.I.
References clear_fullscreen().
Referenced by add_properties(), get_fullscreen(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and GraphicsWindow::set_properties_now().
|
inline |
Returns true if set_icon_filename() has been specified.
Definition at line 685 of file windowProperties.I.
References clear_icon_filename().
Referenced by add_properties(), get_icon_filename(), WinGraphicsWindow::get_ime_hwnd(), output(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_minimized() has been specified.
Definition at line 499 of file windowProperties.I.
References clear_minimized().
Referenced by add_properties(), get_minimized(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_open() has been specified.
Definition at line 594 of file windowProperties.I.
References clear_open().
Referenced by add_properties(), get_open(), output(), and GraphicsWindow::set_properties_now().
|
inline |
Returns true if the window origin has been specified, false otherwise.
Definition at line 129 of file windowProperties.I.
References clear_origin().
Referenced by add_properties(), get_origin(), get_x_origin(), get_y_origin(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), and WinGraphicsWindow::static_window_proc().
|
inline |
Checks the S_parent_window specification from the properties.
Definition at line 904 of file windowProperties.I.
References clear_parent_window().
Referenced by add_properties(), get_parent_window(), and output().
|
inline |
Returns true if set_raw_mice() has been specified.
Definition at line 546 of file windowProperties.I.
References clear_raw_mice().
Referenced by add_properties(), get_raw_mice(), and output().
|
inline |
Returns true if the window size has been specified, false otherwise.
Definition at line 215 of file windowProperties.I.
References clear_size().
Referenced by add_properties(), get_size(), get_x_size(), get_y_size(), GraphicsEngine::make_output(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), and MouseAndKeyboard::set_source().
|
inline |
Returns true if the window title has been specified, false otherwise.
Definition at line 260 of file windowProperties.I.
References clear_title().
Referenced by add_properties(), get_title(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if set_undecorated() has been specified.
Definition at line 308 of file windowProperties.I.
References clear_undecorated().
Referenced by add_properties(), get_undecorated(), and output().
|
inline |
Returns true if the window z_order has been specified, false otherwise.
Definition at line 781 of file windowProperties.I.
References clear_z_order().
Referenced by add_properties(), get_z_order(), output(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
|
inline |
Returns true if any properties have been specified, false otherwise.
Definition at line 52 of file windowProperties.I.
References set_origin().
Referenced by GraphicsWindow::process_events(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), and WinGraphicsWindow::set_properties_now().
void WindowProperties::output | ( | ostream & | out | ) | const |
Sets any properties that are explicitly specified in other on this object.
Leaves other properties unchanged.
Definition at line 298 of file windowProperties.cxx.
References get_cursor_filename(), get_cursor_hidden(), get_fixed_size(), get_foreground(), get_fullscreen(), get_icon_filename(), get_minimized(), get_mouse_mode(), get_open(), get_parent_window(), get_raw_mice(), get_title(), get_undecorated(), get_x_origin(), get_x_size(), get_y_origin(), get_y_size(), get_z_order(), has_cursor_filename(), has_cursor_hidden(), has_fixed_size(), has_foreground(), has_fullscreen(), has_icon_filename(), has_minimized(), has_open(), has_origin(), has_parent_window(), has_raw_mice(), has_size(), has_title(), has_undecorated(), and has_z_order().
Referenced by add_properties(), and clear_parent_window().
|
inline |
Specifies the file that contains the icon to associate with the mouse cursor when it is within the window (and visible).
Definition at line 709 of file windowProperties.I.
References get_cursor_filename().
Referenced by add_properties(), clear_icon_filename(), and get_config_properties().
|
inline |
Specifies whether the mouse cursor should be visible.
Definition at line 615 of file windowProperties.I.
References get_cursor_hidden().
Referenced by add_properties(), clear_open(), and get_config_properties().
|
static |
Replaces the "default" WindowProperties with the specified structure.
The specified WindowProperties will be returned by future calls to get_default(), until clear_default() is called.
Note that this completely replaces the default properties; it is not additive.
Definition at line 126 of file windowProperties.cxx.
References clear_default().
Referenced by get_default().
|
inline |
Specifies whether the window should be resizable by the user.
Definition at line 330 of file windowProperties.I.
References get_fixed_size().
Referenced by add_properties(), clear_undecorated(), and get_config_properties().
|
inline |
Specifies whether the window should be opened in the foreground (true), or left in the background (false).
Definition at line 427 of file windowProperties.I.
References get_foreground().
Referenced by add_properties(), clear_fullscreen(), eglGraphicsWindow::process_events(), x11GraphicsWindow::process_events(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), and WinGraphicsWindow::window_proc().
|
inline |
Specifies whether the window should be opened in fullscreen mode (true) or normal windowed mode (false, the default).
Definition at line 379 of file windowProperties.I.
References get_fullscreen().
Referenced by add_properties(), clear_fixed_size(), and get_config_properties().
|
inline |
Specifies the file that contains the icon to associate with the window when it is minimized.
Definition at line 662 of file windowProperties.I.
References get_icon_filename().
Referenced by add_properties(), clear_cursor_hidden(), and get_config_properties().
|
inline |
Specifies whether the window should be created minimized (true), or normal (false).
Definition at line 474 of file windowProperties.I.
References get_minimized().
Referenced by add_properties(), clear_foreground(), eglGraphicsWindow::process_events(), x11GraphicsWindow::process_events(), AndroidGraphicsWindow::set_properties_now(), and WinGraphicsWindow::window_proc().
|
inline |
Specifies the mode in which the window is to operate its mouse pointer.
M_absolute: the normal mode in which a mouse pointer operates, where the mouse can move outside the window and the mouse coordinates are relative to its position in the window.
M_relative (OSX or Unix/X11 only): a mode where only relative movements are reported; particularly useful for FPS-style mouse movements where you have hidden the mouse pointer and are are more interested in how fast the mouse is moving, rather than precisely where the pointer is hovering.
This has no effect on Windows. On Unix/X11, this requires the Xxf86dga extension to be available.
M_confined: this mode reports absolute mouse positions, but confines the mouse pointer to the window boundary. It can portably replace M_relative for an FPS, but you need to periodically move the pointer to the center of the window and track movement deltas.
Definition at line 827 of file windowProperties.I.
References get_mouse_mode().
Referenced by add_properties(), clear_z_order(), and get_config_properties().
|
inline |
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.
Definition at line 569 of file windowProperties.I.
References get_open().
Referenced by add_properties(), clear_raw_mice(), get_config_properties(), eglGraphicsWindow::process_events(), x11GraphicsWindow::process_events(), GraphicsWindow::request_close(), GraphicsWindow::request_open(), GraphicsWindow::set_close_now(), AndroidGraphicsWindow::set_properties_now(), and WinGraphicsWindow::window_proc().
|
inline |
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.
Definition at line 66 of file windowProperties.I.
Referenced by add_properties(), get_config_properties(), is_any_specified(), x11GraphicsWindow::process_events(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), and CallbackGraphicsWindow::set_properties_now().
|
inline |
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.
Definition at line 81 of file windowProperties.I.
References get_origin().
void WindowProperties::set_parent_window | ( | size_t | parent | ) |
Specifies the window that this window should be attached to.
This is a deprecated variant on this method, and exists only for backward compatibility. Future code should use the version of set_parent_window() below that receives a WindowHandle object; that interface is much more robust.
In this deprecated variant, the actual value for "parent" is platform-specific. On Windows, it is the HWND of the parent window, cast to an unsigned integer. On X11, it is the Window pointer of the parent window, similarly cast. On OSX, this is the NSWindow pointer, which doesn't appear to work at all.
Definition at line 222 of file windowProperties.cxx.
References add_properties().
Referenced by add_properties(), clear(), clear_mouse_mode(), and get_config_properties().
|
inline |
Specifies the window that this window should be attached to.
If this is NULL or unspecified, the window will be created as a toplevel window on the desktop; if this is non-NULL, the window will be bound as a child window to the indicated parent window.
You should use GraphicsPipe::make_window_handle() to create an instance of a WindowHandle object given an appropriate OS-specific window handle representation. Each OS-specific GraphicsPipe class defines a make_window_handle() method that returns an appropriate WindowHandle object to wrap the particular OS-specific representation.
Definition at line 882 of file windowProperties.I.
References get_parent_window().
|
inline |
Specifies whether the window should read the raw mouse devices.
Definition at line 521 of file windowProperties.I.
References get_raw_mice().
Referenced by add_properties(), and clear_minimized().
|
inline |
Specifies the requested size of the window, in pixels.
This is the size of the useful part of the window, not including decorations.
Definition at line 152 of file windowProperties.I.
References size().
Referenced by add_properties(), clear_origin(), get_config_properties(), eglGraphicsWindow::process_events(), x11GraphicsWindow::process_events(), eglGraphicsWindow::set_properties_now(), x11GraphicsWindow::set_properties_now(), AndroidGraphicsWindow::set_properties_now(), WinGraphicsWindow::set_properties_now(), GraphicsWindow::set_properties_now(), CallbackGraphicsWindow::set_properties_now(), size(), and wdxGraphicsWindow9::verify_window_sizes().
|
inline |
Specifies the requested size of the window, in pixels.
This is the size of the useful part of the window, not including decorations.
Definition at line 165 of file windowProperties.I.
References get_size().
|
inline |
Specifies the title that should be assigned to the window.
Definition at line 237 of file windowProperties.I.
References get_title().
Referenced by add_properties(), clear_size(), get_config_properties(), and PandaFramework::get_default_window_props().
|
inline |
Specifies whether the window should be created with a visible title and border (false, the default) or not (true).
Definition at line 283 of file windowProperties.I.
References get_undecorated().
Referenced by add_properties(), clear_title(), get_config_properties(), and eglGraphicsWindow::set_properties_now().
|
inline |
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.
Definition at line 759 of file windowProperties.I.
References get_z_order().
Referenced by add_properties(), clear_cursor_filename(), and get_config_properties().
|
static |
Returns a WindowProperties structure with only the size specified.
The size is the only property that matters to buffers.
Definition at line 155 of file windowProperties.cxx.
References clear(), and set_size().
Referenced by clear_default(), GraphicsStateGuardian::create_gamma_table(), GraphicsOutput::get_num_display_regions(), GraphicsEngine::make_buffer(), GraphicsEngine::make_parasite(), and set_size().