#include <screen.h>

Inheritance diagram for Gdk::Screen:

Public Member Functions
virtual	~Screen ()

GdkScreen *	gobj ()
	Provides access to the underlying C GObject. More...

const GdkScreen *	gobj () const
	Provides access to the underlying C GObject. More...

GdkScreen *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Colormap >	get_default_colormap ()

Glib::RefPtr< const Colormap >	get_default_colormap () const

void	set_default_colormap (const Glib::RefPtr< const Colormap > &colormap)

Glib::RefPtr< Colormap >	get_system_colormap ()

Glib::RefPtr< const Colormap >	get_system_colormap () const

Glib::RefPtr< Visual >	get_system_visual ()

Glib::RefPtr< const Visual >	get_system_visual () const

Glib::RefPtr< Colormap >	get_rgb_colormap ()

Glib::RefPtr< const Colormap >	get_rgb_colormap () const

Glib::RefPtr< Visual >	get_rgb_visual ()

Glib::RefPtr< const Visual >	get_rgb_visual () const

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

Glib::RefPtr< Window >	get_root_window ()

Glib::RefPtr< const Window >	get_root_window () const

Glib::RefPtr< Display >	get_display ()

Glib::RefPtr< const Display >	get_display () const

int	get_number () const

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 ()

Glib::ListHandle< Glib::RefPtr< Window > >	get_toplevel_windows ()

Glib::ustring	make_display_name ()

int	get_n_monitors () const

int	get_primary_monitor () const

void	get_monitor_geometry (int monitor_num, Rectangle &dest) const

int	get_monitor_at_point (int x, int y) const

int	get_monitor_at_window (const Glib::RefPtr< Window > &window) const

int	get_monitor_width_mm (int monitor_num) const

int	get_monitor_height_mm (int monitor_num) const

Glib::ustring	get_monitor_plug_name (int monitor_num) const

void	broadcast_client_message (GdkEvent *event)

template<class ValueType >
bool	get_setting (const Glib::ustring &name, ValueType &value) const

void	set_font_options (const Cairo::FontOptions &options)

Cairo::FontOptions	get_font_options () const

void	set_resolution (double dpi)

double	get_resolution () const

Glib::RefPtr< Gdk::Window >	get_active_window ()

Glib::RefPtr< const Gdk::Window >	get_active_window () const

Glib::ListHandle< Glib::RefPtr< Window > >	get_window_stack ()

Glib::SignalProxy0< void >	signal_size_changed ()

Glib::SignalProxy0< void >	signal_composited_changed ()

Glib::SignalProxy0< void >	signal_monitors_changed ()

Glib::PropertyProxy< Cairo::FontOptions >	property_font_options ()

Glib::PropertyProxy_ReadOnly< Cairo::FontOptions >	property_font_options () const

Glib::PropertyProxy< double >	property_resolution ()

Glib::PropertyProxy_ReadOnly< double >	property_resolution () const

Static Public Member Functions
static GType	get_type () G_GNUC_CONST

static Glib::RefPtr< Screen >	get_default ()

Protected Member Functions
virtual void	on_size_changed ()
	This is a default handler for the signal signal_size_changed(). More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gdk::Screen >	wrap (GdkScreen *object, bool take_copy=false)

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.

Definition at line 65 of file screen.h.

Constructor & Destructor Documentation

◆ ~Screen()

virtual Gdk::Screen::~Screen ( )

virtual

Member Function Documentation

◆ broadcast_client_message()

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.

◆ get_active_window() [1/2]

Glib::RefPtr<Gdk::Window> Gdk::Screen::get_active_window ( )

Returns the screen's currently active window.

On X11, this is done by inspecting the _NET_ACTIVE_WINDOW property on the root window, as described in the Extended Window Manager Hints. If there is no currently currently active window, or the window manager does not support the _NET_ACTIVE_WINDOW hint, this function returns 0.

On other platforms, this function may return 0, depending on whether it is implementable on that platform.

The returned window should be unrefed using Glib::object_unref() when no longer needed.

Returns: The currently active window, or 0.

◆ get_active_window() [2/2]

Glib::RefPtr<const Gdk::Window> Gdk::Screen::get_active_window ( ) const

Returns the screen's currently active window.

On X11, this is done by inspecting the _NET_ACTIVE_WINDOW property on the root window, as described in the Extended Window Manager Hints. If there is no currently currently active window, or the window manager does not support the _NET_ACTIVE_WINDOW hint, this function returns 0.

On other platforms, this function may return 0, depending on whether it is implementable on that platform.

The returned window should be unrefed using Glib::object_unref() when no longer needed.

Returns: The currently active window, or 0.

◆ get_default()

static Glib::RefPtr<Screen> Gdk::Screen::get_default ( )

static

Gets the default screen for the default display. (See Gdk::Display::get_default()).

Returns: A Gdk::Screen, or 0 if there is no default display.

◆ get_default_colormap() [1/2]

Glib::RefPtr<Colormap> Gdk::Screen::get_default_colormap ( )

Gets the default colormap for screen.

Returns: The default Gdk::Colormap.

◆ get_default_colormap() [2/2]

Glib::RefPtr<const Colormap> Gdk::Screen::get_default_colormap ( ) const

Gets the default colormap for screen.

Returns: The default Gdk::Colormap.

◆ get_display() [1/2]

Glib::RefPtr<Display> Gdk::Screen::get_display ( )

Gets the display to which the screen belongs.

Returns: The display to which screen belongs.

◆ get_display() [2/2]

Glib::RefPtr<const Display> Gdk::Screen::get_display ( ) const

Gets the display to which the screen belongs.

Returns: The display to which screen belongs.

◆ get_font_options()

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.

◆ get_height()

int Gdk::Screen::get_height ( ) const

Gets the height of screen in pixels

Returns: The height of screen in pixels.

◆ get_height_mm()

int Gdk::Screen::get_height_mm ( ) const

Returns the height of screen in millimeters. Note that on some X servers this value will not be correct.

Returns: The heigth of screen in millimeters.

◆ get_monitor_at_point()

int Gdk::Screen::get_monitor_at_point	(	int	x,
		int	y
	)		const

Returns the monitor number in which the point ( x, y) is located.

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.

◆ get_monitor_at_window()

int Gdk::Screen::get_monitor_at_window ( const Glib::RefPtr< Window > & window ) const

Returns the number of the monitor in which the largest area of the bounding rectangle of window resides.

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.

◆ get_monitor_geometry()

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, between 0 and gdk_screen_get_n_monitors (screen).
dest	A Gdk::Rectangle to be filled with the monitor geometry.

◆ get_monitor_height_mm()

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, between 0 and gdk_screen_get_n_monitors (screen).

Returns: The height of the monitor, or -1 if not available.

◆ get_monitor_plug_name()

Glib::ustring Gdk::Screen::get_monitor_plug_name ( int monitor_num ) const

Returns the output name of the specified monitor. Usually something like VGA, DVI, or TV, not the actual product name of the display device.

Parameters

monitor_num Number of the monitor, between 0 and gdk_screen_get_n_monitors (screen).

Returns: A newly-allocated string containing the name of the monitor, or 0 if the name cannot be determined.

◆ get_monitor_width_mm()

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, between 0 and gdk_screen_get_n_monitors (screen).

Returns: The width of the monitor, or -1 if not available.

◆ get_n_monitors()

int Gdk::Screen::get_n_monitors ( ) const

Returns the number of monitors which screen consists of.

Returns: Number of monitors which screen consists of.

◆ get_number()

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.

◆ get_primary_monitor()

int Gdk::Screen::get_primary_monitor ( ) const

Gets the primary monitor for screen. The primary monitor is considered the monitor where the 'main desktop' lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor.

If no primary monitor is configured by the user, the return value will be 0, defaulting to the first monitor.

Returns: An integer index for the primary monitor, or 0 if none is configured.

◆ get_resolution()

double Gdk::Screen::get_resolution ( ) const

Gets the resolution for font handling on the screen; see set_resolution() for full details.

Returns: The current resolution, or -1 if no resolution has been set.

◆ get_rgb_colormap() [1/2]

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.

Deprecated: 2.22: Use get_system_colormap()

Returns: The preferred colormap.

◆ get_rgb_colormap() [2/2]

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.

Deprecated: 2.22: Use get_system_colormap()

Returns: The preferred colormap.

◆ get_rgb_visual() [1/2]

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.

Deprecated: 2.22: Use get_system_visual()

Returns: The Gdk::Visual chosen by GdkRGB.

◆ get_rgb_visual() [2/2]

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.

Deprecated: 2.22: Use get_system_visual()

Returns: The Gdk::Visual chosen by GdkRGB.

◆ get_rgba_colormap() [1/2]

Glib::RefPtr<Colormap> Gdk::Screen::get_rgba_colormap ( )

Gets a colormap to use for creating windows or pixmaps with an alpha channel. The windowing system on which GTK+ is running may not support this capability, in which case 0 will be returned. Even if a non-0 value is returned, its possible that the window's alpha channel won't be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display.

This functionality is not implemented in the Windows backend.

For setting an overall opacity for a top-level window, see Gdk::Window::set_opacity().

Returns: A colormap to use for windows with an alpha channel or 0 if the capability is not available.

◆ get_rgba_colormap() [2/2]

Glib::RefPtr<const Colormap> Gdk::Screen::get_rgba_colormap ( ) const

Gets a colormap to use for creating windows or pixmaps with an alpha channel. The windowing system on which GTK+ is running may not support this capability, in which case 0 will be returned. Even if a non-0 value is returned, its possible that the window's alpha channel won't be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display.

This functionality is not implemented in the Windows backend.

For setting an overall opacity for a top-level window, see Gdk::Window::set_opacity().

Returns: A colormap to use for windows with an alpha channel or 0 if the capability is not available.

◆ get_rgba_visual() [1/2]

Glib::RefPtr<Visual> Gdk::Screen::get_rgba_visual ( )

Gets a visual to use for creating windows or pixmaps with an alpha channel. See the docs for get_rgba_colormap() for caveats.

Returns: A visual to use for windows with an alpha channel or 0 if the capability is not available.

◆ get_rgba_visual() [2/2]

Glib::RefPtr<const Visual> Gdk::Screen::get_rgba_visual ( ) const

Gets a visual to use for creating windows or pixmaps with an alpha channel. See the docs for get_rgba_colormap() for caveats.

Returns: A visual to use for windows with an alpha channel or 0 if the capability is not available.

◆ get_root_window() [1/2]

Glib::RefPtr<Window> Gdk::Screen::get_root_window ( )

Gets the root window of screen.

Returns: The root window.

◆ get_root_window() [2/2]

Glib::RefPtr<const Window> Gdk::Screen::get_root_window ( ) const

Gets the root window of screen.

Returns: The root window.

◆ get_setting()

template<class ValueType >

bool Gdk::Screen::get_setting	(	const Glib::ustring &	name,
		ValueType &	value
	)		const

Definition at line 652 of file screen.h.

◆ get_system_colormap() [1/2]

Glib::RefPtr<Colormap> Gdk::Screen::get_system_colormap ( )

Gets the system's default colormap for screen

Returns: The default colormap for screen.

◆ get_system_colormap() [2/2]

Glib::RefPtr<const Colormap> Gdk::Screen::get_system_colormap ( ) const

Gets the system's default colormap for screen

Returns: The default colormap for screen.

◆ get_system_visual() [1/2]

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.

◆ get_system_visual() [2/2]

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.

◆ get_toplevel_windows()

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()).

Returns: List of toplevel windows.

◆ get_type()

static GType Gdk::Screen::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_width()

int Gdk::Screen::get_width ( ) const

Gets the width of screen in pixels

Returns: The width of screen in pixels.

◆ get_width_mm()

int Gdk::Screen::get_width_mm ( ) const

Gets the width of screen in millimeters. Note that on some X servers this value will not be correct.

Returns: The width of screen in millimeters.

◆ get_window_stack()

Glib::ListHandle< Glib::RefPtr<Window> > Gdk::Screen::get_window_stack ( )

Returns a List of Gdk::Windows representing the current window stack.

On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING property on the root window, as described in the Extended Window Manager Hints. If the window manager does not support the _NET_CLIENT_LIST_STACKING hint, this function returns 0.

On other platforms, this function may return 0, depending on whether it is implementable on that platform.

The returned list is newly allocated and owns references to the windows it contains, so it should be freed using Glib::list_free() and its windows unrefed using Glib::object_unref() when no longer needed.

Returns: A list of Gdk::Windows for the current window stack, or 0.

◆ gobj() [1/2]

GdkScreen* Gdk::Screen::gobj ( )

inline

Provides access to the underlying C GObject.

Definition at line 104 of file screen.h.

◆ gobj() [2/2]

const GdkScreen* Gdk::Screen::gobj ( ) const

inline

Provides access to the underlying C GObject.

Definition at line 107 of file screen.h.

◆ gobj_copy()

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.

◆ is_composited()

bool Gdk::Screen::is_composited ( ) const

Returns whether windows with an RGBA visual can reasonably be expected to have their alpha channel drawn correctly on the screen.

On X11 this function returns whether a compositing manager is compositing screen.

Returns: Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.

◆ list_visuals()

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.

Returns: A list of visuals.

◆ make_display_name()

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: The name.

◆ on_size_changed()

virtual void Gdk::Screen::on_size_changed ( )

protectedvirtual

This is a default handler for the signal signal_size_changed().

◆ property_font_options() [1/2]

Glib::PropertyProxy< Cairo::FontOptions > Gdk::Screen::property_font_options ( )

The default font options for the screen.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_font_options() [2/2]

Glib::PropertyProxy_ReadOnly< Cairo::FontOptions > Gdk::Screen::property_font_options ( ) const

The default font options for the screen.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_resolution() [1/2]

Glib::PropertyProxy< double > Gdk::Screen::property_resolution ( )

The resolution for fonts on the screen.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_resolution() [2/2]

Glib::PropertyProxy_ReadOnly< double > Gdk::Screen::property_resolution ( ) const

The resolution for fonts on the screen.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_default_colormap()

void Gdk::Screen::set_default_colormap ( const Glib::RefPtr< const Colormap > & colormap )

Sets the default colormap for screen.

Parameters

colormap A Gdk::Colormap.

◆ set_font_options()

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.

◆ set_resolution()

void Gdk::Screen::set_resolution ( double dpi )

Sets the resolution for font handling on the screen. This is a scale factor between points specified in a Pango::FontDescription and cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3).

Parameters

dpi	The resolution in "dots per inch". (Physical inches aren't actually involved; the terminology is conventional.).

◆ signal_composited_changed()

Glib::SignalProxy0< void > Gdk::Screen::signal_composited_changed ( )

Slot Prototype:: void on_my_composited_changed()

◆ signal_monitors_changed()

Glib::SignalProxy0< void > Gdk::Screen::signal_monitors_changed ( )

Slot Prototype:: void on_my_monitors_changed()

◆ signal_size_changed()

Glib::SignalProxy0< void > Gdk::Screen::signal_size_changed ( )

The size_changed signal is emitted when the pixel width or height of a screen changes.

Slot Prototype:: void on_my_size_changed()

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gdk::Screen > wrap	(	GdkScreen *	object,
		bool	take_copy = `false`
	)

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:

screen.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Screen()

Member Function Documentation

◆ broadcast_client_message()

◆ get_active_window() [1/2]

◆ get_active_window() [2/2]

◆ get_default()

◆ get_default_colormap() [1/2]

◆ get_default_colormap() [2/2]

◆ get_display() [1/2]

◆ get_display() [2/2]

◆ get_font_options()

◆ get_height()

◆ get_height_mm()

◆ get_monitor_at_point()

◆ get_monitor_at_window()

◆ get_monitor_geometry()

◆ get_monitor_height_mm()

◆ get_monitor_plug_name()

◆ get_monitor_width_mm()

◆ get_n_monitors()

◆ get_number()

◆ get_primary_monitor()

◆ get_resolution()

◆ get_rgb_colormap() [1/2]

◆ get_rgb_colormap() [2/2]

◆ get_rgb_visual() [1/2]

◆ get_rgb_visual() [2/2]

◆ get_rgba_colormap() [1/2]

◆ get_rgba_colormap() [2/2]

◆ get_rgba_visual() [1/2]

◆ get_rgba_visual() [2/2]

◆ get_root_window() [1/2]

◆ get_root_window() [2/2]

◆ get_setting()

◆ get_system_colormap() [1/2]

◆ get_system_colormap() [2/2]

◆ get_system_visual() [1/2]

◆ get_system_visual() [2/2]

◆ get_toplevel_windows()

◆ get_type()

◆ get_width()

◆ get_width_mm()

◆ get_window_stack()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ is_composited()

◆ list_visuals()

◆ make_display_name()

◆ on_size_changed()

◆ property_font_options() [1/2]

◆ property_font_options() [2/2]

◆ property_resolution() [1/2]

◆ property_resolution() [2/2]

◆ set_default_colormap()

◆ set_font_options()

◆ set_resolution()

◆ signal_composited_changed()

◆ signal_monitors_changed()

◆ signal_size_changed()

Friends And Related Function Documentation

◆ wrap()