Gdk::ToplevelSurfaceImpl Class Reference

Gdk::ToplevelSurfaceImpl is a Gdk::Surface that implements the Gdk::Toplevel interface. More...

#include <gdkmm/toplevelsurfaceimpl.h>

Inheritance diagram for Gdk::ToplevelSurfaceImpl:

Public Member Functions
	ToplevelSurfaceImpl (ToplevelSurfaceImpl &&src) noexcept
ToplevelSurfaceImpl &	operator= (ToplevelSurfaceImpl &&src) noexcept
	~ToplevelSurfaceImpl () noexcept override
Public Member Functions inherited from Gdk::Toplevel
	Toplevel (Toplevel &&src) noexcept
Toplevel &	operator= (Toplevel &&src) noexcept
	~Toplevel () noexcept override
GdkToplevel *	gobj ()
	Provides access to the underlying C GObject.
const GdkToplevel *	gobj () const
	Provides access to the underlying C GObject.
void	present (const Glib::RefPtr< ToplevelLayout > &layout)
	Present toplevel after having processed the Gdk::ToplevelLayout rules.
bool	minimize ()
	Asks to minimize the toplevel.
bool	lower ()
	Asks to lower the toplevel below other windows.
void	focus (guint32 timestamp)
	Sets keyboard focus to surface.
State	get_state () const
	Gets the bitwise or of the currently active surface state flags, from the Gdk::Toplevel::State enumeration.
void	set_title (const Glib::ustring &title)
	Sets the title of a toplevel surface.
void	set_startup_id (const Glib::ustring &startup_id)
	Sets the startup notification ID.
void	set_transient_for (const Glib::RefPtr< Surface > & parent)
	Sets a transient-for parent.
void	set_modal (bool modal=true)
	Sets the toplevel to be modal.
void	set_icon_list (const std::vector< Glib::RefPtr< Texture > > &surfaces)
	Sets a list of icons for the surface.
bool	show_window_menu (const Glib::RefPtr< Event > & event)
	Asks the windowing system to show the window menu.
void	set_decorated (bool decorated=true)
	Sets the toplevel to be decorated.
void	set_deletable (bool deletable=true)
	Sets the toplevel to be deletable.
bool	supports_edge_constraints () const
	Returns whether the desktop environment supports tiled window states.
void	inhibit_system_shortcuts (const Glib::RefPtr< Event > & event)
	Requests that the toplevel inhibit the system shortcuts.
void	restore_system_shortcuts ()
	Restore default system keyboard shortcuts which were previously inhibited.
void	begin_resize (SurfaceEdge edge, const Glib::RefPtr< Device > &device, int button, double x, double y, guint32 timestamp)
	Begins an interactive resize operation.
void	begin_move (const Glib::RefPtr< Device > &device, int button, double x, double y, guint32 timestamp)
	Begins an interactive move operation.
Glib::SignalProxy< void(ToplevelSize &)>	signal_compute_size ()
Glib::PropertyProxy_ReadOnly< State >	property_state () const
	The state of the toplevel.
Glib::PropertyProxy< Glib::ustring >	property_title ()
	The title of the surface.
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_title () const
	The title of the surface.
Glib::PropertyProxy< Glib::ustring >	property_startup_id ()
	The startup ID of the surface.
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_startup_id () const
	The startup ID of the surface.
Glib::PropertyProxy< Glib::RefPtr< Surface > >	property_transient_for ()
	The transient parent of the surface.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Surface > >	property_transient_for () const
	The transient parent of the surface.
Glib::PropertyProxy< bool >	property_modal ()
	Whether the surface is modal.
Glib::PropertyProxy_ReadOnly< bool >	property_modal () const
	Whether the surface is modal.
Glib::PropertyProxy< bool >	property_decorated ()
	Whether the window manager should add decorations.
Glib::PropertyProxy_ReadOnly< bool >	property_decorated () const
	Whether the window manager should add decorations.
Glib::PropertyProxy< bool >	property_deletable ()
	Whether the window manager should allow to close the surface.
Glib::PropertyProxy_ReadOnly< bool >	property_deletable () const
	Whether the window manager should allow to close the surface.
Glib::PropertyProxy< FullscreenMode >	property_fullscreen_mode ()
	The fullscreen mode of the surface.
Glib::PropertyProxy_ReadOnly< FullscreenMode >	property_fullscreen_mode () const
	The fullscreen mode of the surface.
Glib::PropertyProxy_ReadOnly< bool >	property_shortcuts_inhibited () const
	Whether the surface should inhibit keyboard shortcuts.
Public Member Functions inherited from Gdk::Surface
	Surface (Surface &&src) noexcept
Surface &	operator= (Surface &&src) noexcept
	~Surface () noexcept override
GdkSurface *	gobj ()
	Provides access to the underlying C GObject.
const GdkSurface *	gobj () const
	Provides access to the underlying C GObject.
GdkSurface *	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< Display >	get_display ()
	Gets the Gdk::Display associated with a Gdk::Surface.
Glib::RefPtr< const Display >	get_display () const
	Gets the Gdk::Display associated with a Gdk::Surface.
void	hide ()
	Hide the surface.
void	set_input_region (const ::Cairo::RefPtr< ::Cairo::Region > &region)
	Apply the region to the surface for the purpose of event handling.
bool	get_mapped () const
	Checks whether the surface has been mapped.
void	set_cursor (const Glib::RefPtr< Cursor > &cursor)
	Sets the default mouse pointer for a Gdk::Surface.
void	set_cursor ()
	Use the parent surface's cursor.
void	set_device_cursor (const Glib::RefPtr< Device > &device, const Glib::RefPtr< Cursor > &cursor)
	Sets a specific Gdk::Cursor for a given device when it gets inside surface.
Glib::RefPtr< Cursor >	get_device_cursor (const Glib::RefPtr< Device > &device)
	Retrieves a Gdk::Cursor pointer for the device currently set on the specified Gdk::Surface.
Glib::RefPtr< const Cursor >	get_device_cursor (const Glib::RefPtr< const Device > &device) const
	Retrieves a Gdk::Cursor pointer for the device currently set on the specified Gdk::Surface.
Glib::RefPtr< Cursor >	get_cursor ()
	Retrieves a Gdk::Cursor pointer for the cursor currently set on the Gdk::Surface.
Glib::RefPtr< const Cursor >	get_cursor () const
	Retrieves a Gdk::Cursor pointer for the cursor currently set on the Gdk::Surface.
int	get_width () const
	Returns the width of the given surface.
int	get_height () const
	Returns the height of the given surface.
int	get_scale_factor () const
	Returns the internal scale factor that maps from surface coordinates to the actual device pixels.
double	get_scale () const
	Returns the internal scale that maps from surface coordinates to the actual device pixels.
bool	get_device_position (const Glib::RefPtr< const Device > &device, double &x, double &y, ModifierType &mask) const
	Obtains the current device position and modifier state.
::Cairo::RefPtr< ::Cairo::Surface >	create_similar_surface (::Cairo::Content content, int width, int height)
	Create a new Cairo surface that is as compatible as possible with the given surface.
void	beep ()
	Emits a short beep associated to surface.
Glib::RefPtr< Drag >	drag_begin_from_point (const Glib::RefPtr< Device > &device, const Glib::RefPtr< ContentProvider > &content, DragAction actions, double dx, double dy)
	Starts a drag and creates a new drag context for it.
void	queue_render ()
	Forces a signal_render() signal emission for surface to be scheduled.
void	request_layout ()
	Request a layout phase from the surface's frame clock.
Glib::RefPtr< FrameClock >	get_frame_clock ()
	Gets the frame clock for the surface.
Glib::RefPtr< const FrameClock >	get_frame_clock () const
	Gets the frame clock for the surface.
void	set_opaque_region (const ::Cairo::RefPtr< const ::Cairo::Region > &region)
	Marks a region of the Gdk::Surface as opaque.
Glib::RefPtr< Gdk::GLContext >	create_gl_context ()
	Creates a new GLContext matching the framebuffer format to the visual of the Surface.
Glib::RefPtr< Gdk::CairoContext >	create_cairo_context ()
	Creates a new Gdk::CairoContext for rendering on surface.
Glib::SignalProxy< void(int, int)>	signal_layout ()
Glib::SignalProxy< bool(const ::Cairo::RefPtr< const ::Cairo::Region > &)>	signal_render ()
Glib::SignalProxy< bool(const Glib::RefPtr< const Event > &)>	signal_event ()
Glib::SignalProxy< void(const Glib::RefPtr< Monitor > &)>	signal_enter_monitor ()
Glib::SignalProxy< void(const Glib::RefPtr< Monitor > &)>	signal_leave_monitor ()
Glib::PropertyProxy< Glib::RefPtr< Cursor > >	property_cursor ()
	The mouse pointer for the Gdk::Surface.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Cursor > >	property_cursor () const
	The mouse pointer for the Gdk::Surface.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > >	property_display () const
	The Gdk::Display connection of the surface.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< FrameClock > >	property_frame_clock () const
	The Gdk::FrameClock of the surface.
Glib::PropertyProxy_ReadOnly< bool >	property_mapped () const
	Whether the surface is mapped.
Glib::PropertyProxy_ReadOnly< int >	property_width () const
	The width of the surface in pixels.
Glib::PropertyProxy_ReadOnly< int >	property_height () const
	The height of the surface, in pixels.
Glib::PropertyProxy_ReadOnly< int >	property_scale_factor () const
	The scale factor of the surface.
Glib::PropertyProxy_ReadOnly< double >	property_scale () const
	The scale of the surface.

Additional Inherited Members
Public Types inherited from Gdk::Toplevel
enum class	State {   MINIMIZED = 1 << 0 ,   MAXIMIZED = 1 << 1 ,   STICKY = 1 << 2 ,   FULLSCREEN = 1 << 3 ,   ABOVE = 1 << 4 ,   BELOW = 1 << 5 ,   FOCUSED = 1 << 6 ,   TILED = 1 << 7 ,   TOP_TILED = 1 << 8 ,   TOP_RESIZABLE = 1 << 9 ,   RIGHT_TILED = 1 << 10 ,   RIGHT_RESIZABLE = 1 << 11 ,   BOTTOM_TILED = 1 << 12 ,   BOTTOM_RESIZABLE = 1 << 13 ,   LEFT_TILED = 1 << 14 ,   LEFT_RESIZABLE = 1 << 15 ,   SUSPENDED = 1 << 16 }
Static Public Member Functions inherited from Gdk::Toplevel
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gdk::Surface
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< Surface >	create_toplevel (const Glib::RefPtr< Display > &display)
	Creates a new toplevel surface.
static Glib::RefPtr< Surface >	create_popup (const Glib::RefPtr< Surface > & parent, bool autohide)
	Create a new popup surface.
Protected Member Functions inherited from Gdk::Toplevel
	Toplevel ()
	You should derive from this class to use it.
Related Symbols inherited from Gdk::Toplevel
Glib::RefPtr< Gdk::Toplevel >	wrap (GdkToplevel *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gdk::Surface
Glib::RefPtr< Gdk::Surface >	wrap (GdkSurface *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Gdk::ToplevelSurfaceImpl is a Gdk::Surface that implements the Gdk::Toplevel interface.

The GdkToplevel interface can be implemented by C classes that derive from GdkSurface. No public GTK class implements GdkToplevel. Some GTK functions, such as gdk_surface_new_toplevel(), return an object of a class which is derived from GdkSurface and implements GdkToplevel. Since that C class is not public, it's not wrapped in a C++ class. A C object of such a class can be wrapped in a Gdk::ToplevelSurfaceImpl object. Gdk::ToplevelSurfaceImpl does not directly correspond to any GTK class.

This class is intended only for wrapping C objects returned from GTK functions.

See also

Gdk::Surface::create_toplevel()

Since gtkmm 3.98:

Constructor & Destructor Documentation

ToplevelSurfaceImpl()

Gdk::ToplevelSurfaceImpl::ToplevelSurfaceImpl ( ToplevelSurfaceImpl &&  src )

noexcept

~ToplevelSurfaceImpl()

Gdk::ToplevelSurfaceImpl::~ToplevelSurfaceImpl ( )

overridenoexcept

Member Function Documentation

operator=()

ToplevelSurfaceImpl & Gdk::ToplevelSurfaceImpl::operator= ( ToplevelSurfaceImpl &&  src )

noexcept