Gdk::Screen Class Reference
Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical screen. More...Inherits Glib::Object.
Public Member Functions | |
virtual | ~Screen () |
GdkScreen* | gobj () |
Provides access to the underlying C GObject. | |
const GdkScreen* | gobj () const |
Provides access to the underlying C GObject. | |
GdkScreen* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Glib::RefPtr< Colormap > | get_default_colormap () |
Gets the default colormap for screen. | |
Glib::RefPtr< const Colormap > | get_default_colormap () const |
Gets the default colormap for screen. | |
void | set_default_colormap (const Glib::RefPtr< const Colormap >& colormap) |
Glib::RefPtr< Colormap > | get_system_colormap () |
Gets the system's default colormap for screen. | |
Glib::RefPtr< const Colormap > | get_system_colormap () const |
Gets the system's default colormap for screen. | |
Glib::RefPtr< Visual > | get_system_visual () |
Get the system's default visual for screen. | |
Glib::RefPtr< const Visual > | get_system_visual () const |
Get the system's default visual for screen. | |
Glib::RefPtr< Colormap > | get_rgb_colormap () |
Gets the preferred colormap for rendering image data on screen. | |
Glib::RefPtr< const Colormap > | get_rgb_colormap () const |
Gets the preferred colormap for rendering image data on screen. | |
Glib::RefPtr< Visual > | get_rgb_visual () |
Gets a "preferred visual" chosen by GdkRGB for rendering image data on screen. | |
Glib::RefPtr< const Visual > | get_rgb_visual () const |
Gets a "preferred visual" chosen by GdkRGB for rendering image data on screen. | |
Glib::RefPtr< Colormap > | get_rgba_colormap () |
Glib::RefPtr< const Colormap > | get_rgba_colormap () const |
Glib::RefPtr< Visual > | get_rgba_visual () |
Glib::RefPtr< const Visual > | get_rgba_visual () const |
bool | is_composited () const |
Return value: Whether windows with RGBA visuals can reasonably be. | |
Glib::RefPtr< Window > | get_root_window () |
Gets the root window of screen. | |
Glib::RefPtr< const Window > | get_root_window () const |
Gets the root window of screen. | |
Glib::RefPtr< Display > | get_display () |
Gets the display to which the screen belongs. | |
Glib::RefPtr< const Display > | get_display () const |
Gets the display to which the screen belongs. | |
int | get_number () const |
Gets the index of screen among the screens in the display to which it belongs. | |
int | get_width () const |
int | get_height () const |
int | get_width_mm () const |
int | get_height_mm () const |
Glib::ListHandle< Glib::RefPtr < Visual > > | list_visuals () |
Lists the available visuals for the specified screen. | |
Glib::ListHandle< Glib::RefPtr < Window > > | get_toplevel_windows () |
Obtains a list of all toplevel windows known to GDK on the screen screen. | |
Glib::ustring | make_display_name () |
Determines the name to pass to Gdk::Display::open() to get a Gdk::Display with this screen as the default screen. | |
int | get_n_monitors () const |
Returns: number of monitors which screen consists of. | |
void | get_monitor_geometry (int monitor_num, Rectangle& dest) const |
Retrieves the Gdk::Rectangle representing the size and position of the individual monitor within the entire screen area. | |
int | get_monitor_at_point (int x, int y) const |
Returns: the monitor number in which the point ( x, y) lies, or. | |
int | get_monitor_at_window (const Glib::RefPtr< Window >& window) const |
int | get_monitor_width_mm (int monitor_num) const |
Gets the width in millimeters of the specified monitor, if available. | |
int | get_monitor_height_mm (int monitor_num) const |
Gets the height in millimeters of the specified monitor. | |
Glib::ustring | get_monitor_plug_name (int monitor_num) const |
Returns: a newly-allocated string containing the name of the monitor,. | |
void | broadcast_client_message (GdkEvent* event) |
On X11, sends an X ClientMessage event to all toplevel windows on screen. | |
template<class ValueType > | |
bool | get_setting (const Glib::ustring& name, ValueType&value) const |
void | set_font_options (const Cairo::FontOptions& options) |
Sets the default font options for the screen. | |
Cairo::FontOptions | get_font_options () const |
Gets any options previously set with set_font_options(). | |
void | set_resolution (double dpi) |
double | get_resolution () const |
Glib::RefPtr< Gdk::Window > | get_active_window () |
Return value: the currently active window, or 0 . | |
Glib::RefPtr< const Gdk::Window > | get_active_window () const |
Return value: the currently active window, or 0 . | |
Glib::ListHandle< Glib::RefPtr < Window > > | get_window_stack () |
Glib::SignalProxy0< void > | signal_size_changed () |
The size_changed signal is emitted when the pixel width or height of a screen changes. | |
Static Public Member Functions | |
static Glib::RefPtr< Screen > | get_default () |
Protected Member Functions | |
virtual void | on_size_changed () |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::Screen > | wrap (GdkScreen* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
Detailed Description
Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical screen.It is used throughout GDK and GTK+ to specify which screen the top level windows are to be displayed on. It is also used to query the screen specification and default settings such as the default colormap (get_default_colormap()), the screen width (get_width()), etc. Note that a screen may consist of multiple monitors which are merged to form a large screen area.
Constructor& Destructor Documentation
virtual Gdk::Screen::~Screen | ( | ) | [virtual] |
Member Function Documentation
void Gdk::Screen::broadcast_client_message | ( | GdkEvent * | event | ) |
On X11, sends an X ClientMessage event to all toplevel windows on screen.
Toplevel windows are determined by checking for the WM_STATE property, as described in the Inter-Client Communication Conventions Manual (ICCCM). If no windows are found with the WM_STATE property set, the message is sent to all children of the root window.
On Windows, broadcasts a message registered with the name GDK_WIN32_CLIENT_MESSAGE to all top-level windows. The amount of data is limited to one long, i.e. four bytes.
- Parameters:
-
event The Gdk::Event.
Glib::RefPtr<const Gdk::Window> Gdk::Screen::get_active_window | ( | ) | const |
Return value: the currently active window, or 0
.
- Returns:
- The currently active window, or
0
.
Glib::RefPtr<Gdk::Window> Gdk::Screen::get_active_window | ( | ) |
Return value: the currently active window, or 0
.
- Returns:
- The currently active window, or
0
.
static Glib::RefPtr<Screen> Gdk::Screen::get_default | ( | ) | [static] |
Glib::RefPtr<const Colormap> Gdk::Screen::get_default_colormap | ( | ) | const |
Glib::RefPtr<Colormap> Gdk::Screen::get_default_colormap | ( | ) |
Glib::RefPtr<const Display> Gdk::Screen::get_display | ( | ) | const |
Gets the display to which the screen belongs.
- Returns:
- The display to which screen belongs
Glib::RefPtr<Display> Gdk::Screen::get_display | ( | ) |
Gets the display to which the screen belongs.
- Returns:
- The display to which screen belongs
Cairo::FontOptions Gdk::Screen::get_font_options | ( | ) | const |
Gets any options previously set with set_font_options().
- Returns:
- The current font options, or
0
if no default font options have been set.
int Gdk::Screen::get_height | ( | ) | const |
int Gdk::Screen::get_height_mm | ( | ) | const |
int Gdk::Screen::get_monitor_at_point | ( | int | x, | |
int | y | |||
) | const |
Returns: the monitor number in which the point ( x, y) lies, or.
- Parameters:
-
x The x coordinate in the virtual screen. y The y coordinate in the virtual screen.
- Returns:
- The monitor number in which the point ( x, y) lies, or a monitor close to ( x, y) if the point is not in any monitor.
int Gdk::Screen::get_monitor_at_window | ( | const Glib::RefPtr< Window >& | window | ) | const |
- Parameters:
-
window A Gdk::Window.
- Returns:
- The monitor number in which most of window is located, or if window does not intersect any monitors, a monitor, close to window. the number of the monitor in which the largest area of the bounding rectangle of window resides.
void Gdk::Screen::get_monitor_geometry | ( | int | monitor_num, | |
Rectangle& | dest | |||
) | const |
Retrieves the Gdk::Rectangle representing the size and position of the individual monitor within the entire screen area.
Note that the size of the entire screen area can be retrieved via get_width() and get_height().
- Parameters:
-
monitor_num The monitor number. dest A Gdk::Rectangle to be filled with the monitor geometry.
int Gdk::Screen::get_monitor_height_mm | ( | int | monitor_num | ) | const |
Gets the height in millimeters of the specified monitor.
- Parameters:
-
monitor_num Number of the monitor.
- Returns:
- The height of the monitor, or -1 if not available
Glib::ustring Gdk::Screen::get_monitor_plug_name | ( | int | monitor_num | ) | const |
Returns: a newly-allocated string containing the name of the monitor,.
- Parameters:
-
monitor_num Number of the monitor.
- Returns:
- A newly-allocated string containing the name of the monitor, or
0
if the name cannot be determined
int Gdk::Screen::get_monitor_width_mm | ( | int | monitor_num | ) | const |
Gets the width in millimeters of the specified monitor, if available.
- Parameters:
-
monitor_num Number of the monitor.
- Returns:
- The width of the monitor, or -1 if not available
int Gdk::Screen::get_n_monitors | ( | ) | const |
Returns: number of monitors which screen consists of.
- Returns:
- Number of monitors which screen consists of.
int Gdk::Screen::get_number | ( | ) | const |
Gets the index of screen among the screens in the display to which it belongs.
(See get_display())
- Returns:
- The index
double Gdk::Screen::get_resolution | ( | ) | const |
Glib::RefPtr<const Colormap> Gdk::Screen::get_rgb_colormap | ( | ) | const |
Gets the preferred colormap for rendering image data on screen.
Not a very useful function; historically, GDK could only render RGB image data to one colormap and visual, but in the current version it can render to any colormap and visual. So there's no need to call this function.
- Returns:
- The preferred colormap
Glib::RefPtr<Colormap> Gdk::Screen::get_rgb_colormap | ( | ) |
Gets the preferred colormap for rendering image data on screen.
Not a very useful function; historically, GDK could only render RGB image data to one colormap and visual, but in the current version it can render to any colormap and visual. So there's no need to call this function.
- Returns:
- The preferred colormap
Glib::RefPtr<const Visual> Gdk::Screen::get_rgb_visual | ( | ) | const |
Gets a "preferred visual" chosen by GdkRGB for rendering image data on screen.
In previous versions of GDK, this was the only visual GdkRGB could use for rendering. In current versions, it's simply the visual GdkRGB would have chosen as the optimal one in those previous versions. GdkRGB can now render to drawables with any visual.
- Returns:
- The Gdk::Visual chosen by GdkRGB.
Glib::RefPtr<Visual> Gdk::Screen::get_rgb_visual | ( | ) |
Gets a "preferred visual" chosen by GdkRGB for rendering image data on screen.
In previous versions of GDK, this was the only visual GdkRGB could use for rendering. In current versions, it's simply the visual GdkRGB would have chosen as the optimal one in those previous versions. GdkRGB can now render to drawables with any visual.
- Returns:
- The Gdk::Visual chosen by GdkRGB.
Glib::RefPtr<const Colormap> Gdk::Screen::get_rgba_colormap | ( | ) | const |
Glib::RefPtr<Colormap> Gdk::Screen::get_rgba_colormap | ( | ) |
Glib::RefPtr<const Visual> Gdk::Screen::get_rgba_visual | ( | ) | const |
Glib::RefPtr<Visual> Gdk::Screen::get_rgba_visual | ( | ) |
Glib::RefPtr<const Window> Gdk::Screen::get_root_window | ( | ) | const |
Glib::RefPtr<Window> Gdk::Screen::get_root_window | ( | ) |
bool Gdk::Screen::get_setting | ( | const Glib::ustring & | name, | |
ValueType & | value | |||
) | const [inline] |
Glib::RefPtr<const Colormap> Gdk::Screen::get_system_colormap | ( | ) | const |
Gets the system's default colormap for screen.
- Returns:
- The default colormap for screen.
Glib::RefPtr<Colormap> Gdk::Screen::get_system_colormap | ( | ) |
Gets the system's default colormap for screen.
- Returns:
- The default colormap for screen.
Glib::RefPtr<const Visual> Gdk::Screen::get_system_visual | ( | ) | const |
Get the system's default visual for screen.
This is the visual for the root window of the display. The return value should not be freed.
- Returns:
- The system visual
Glib::RefPtr<Visual> Gdk::Screen::get_system_visual | ( | ) |
Get the system's default visual for screen.
This is the visual for the root window of the display. The return value should not be freed.
- Returns:
- The system visual
Glib::ListHandle< Glib::RefPtr<Window> > Gdk::Screen::get_toplevel_windows | ( | ) |
Obtains a list of all toplevel windows known to GDK on the screen screen.
A toplevel window is a child of the root window (see gdk_get_default_root_window()).
The returned list should be freed with Glib::list_free(), but its elements need not be freed.
- Returns:
- List of toplevel windows, free with Glib::list_free()
int Gdk::Screen::get_width | ( | ) | const |
int Gdk::Screen::get_width_mm | ( | ) | const |
Glib::ListHandle< Glib::RefPtr<Window> > Gdk::Screen::get_window_stack | ( | ) |
const GdkScreen* Gdk::Screen::gobj | ( | ) | const [inline] |
GdkScreen* Gdk::Screen::gobj | ( | ) | [inline] |
GdkScreen* Gdk::Screen::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gdk::Screen::is_composited | ( | ) | const |
Return value: Whether windows with RGBA visuals can reasonably be.
- Returns:
- Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.
Glib::ListHandle< Glib::RefPtr<Visual> > Gdk::Screen::list_visuals | ( | ) |
Lists the available visuals for the specified screen.
A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format.
Call Glib::list_free() on the return value when you're finished with it.
- Returns:
- A list of visuals; the list must be freed, but not its contents
Glib::ustring Gdk::Screen::make_display_name | ( | ) |
Determines the name to pass to Gdk::Display::open() to get a Gdk::Display with this screen as the default screen.
- Returns:
- A newly allocated string, free with Glib::free()
virtual void Gdk::Screen::on_size_changed | ( | ) | [protected, virtual] |
void Gdk::Screen::set_default_colormap | ( | const Glib::RefPtr< const Colormap >& | colormap | ) |
void Gdk::Screen::set_font_options | ( | const Cairo::FontOptions & | options | ) |
Sets the default font options for the screen.
These options will be set on any Pango::Context's newly created with gdk_pango_context_get_for_screen(). Changing the default set of font options does not affect contexts that have already been created.
- Parameters:
-
options A cairo_font_options_t, or 0
to unset any previously set default font options.
void Gdk::Screen::set_resolution | ( | double | dpi | ) |
Glib::SignalProxy0< void > Gdk::Screen::signal_size_changed | ( | ) |
The size_changed signal is emitted when the pixel width or height of a screen changes.
- Prototype:
void on_my_size_changed()
Friends And Related Function Documentation
Glib::RefPtr< Gdk::Screen > wrap | ( | GdkScreen * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
- Parameters:
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns:
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file:
- gdkmm/screen.h