Gdk::PopupSurfaceImpl Class Reference

Gdk::PopupSurfaceImpl is a Gdk::Surface that implements the Gdk::Popup interface. More...

#include <gdkmm/popupsurfaceimpl.h>

Inheritance diagram for Gdk::PopupSurfaceImpl:

Public Member Functions
	PopupSurfaceImpl (PopupSurfaceImpl &&src) noexcept
PopupSurfaceImpl &	operator= (PopupSurfaceImpl &&src) noexcept
	~PopupSurfaceImpl () noexcept override
Public Member Functions inherited from Gdk::Popup
	Popup (Popup &&src) noexcept
Popup &	operator= (Popup &&src) noexcept
	~Popup () noexcept override
GdkPopup *	gobj ()
	Provides access to the underlying C GObject.
const GdkPopup *	gobj () const
	Provides access to the underlying C GObject.
bool	present (int width, int height, const Glib::RefPtr< PopupLayout > &layout)
	Present popup after having processed the Gdk::PopupLayout rules.
Gravity	get_surface_anchor () const
	Gets the current popup surface anchor.
Gravity	get_rect_anchor () const
	Gets the current popup rectangle anchor.
Glib::RefPtr< Surface >	get_parent ()
	Returns the parent surface of a popup.
Glib::RefPtr< const Surface >	get_parent () const
	Returns the parent surface of a popup.
int	get_position_x () const
	Obtains the position of the popup relative to its parent.
int	get_position_y () const
	Obtains the position of the popup relative to its parent.
bool	get_autohide () const
	Returns whether this popup is set to hide on outside clicks.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Surface > >	property_parent () const
	The parent surface.
Glib::PropertyProxy_ReadOnly< bool >	property_autohide () const
	Whether to hide on outside clicks.
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
Static Public Member Functions inherited from Gdk::Popup
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::Popup
	Popup ()
	You should derive from this class to use it.
Related Symbols inherited from Gdk::Popup
Glib::RefPtr< Gdk::Popup >	wrap (GdkPopup *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::PopupSurfaceImpl is a Gdk::Surface that implements the Gdk::Popup interface.

The GdkPopup interface can be implemented by C classes that derive from GdkSurface. No public GTK class implements GdkPopup. Some GTK functions, such as gdk_surface_new_popup(), return an object of a class which is derived from GdkSurface and implements GdkPopup. 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::PopupSurfaceImpl object. Gdk::PopupSurfaceImpl 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_popup()

Since gtkmm 3.98:

Constructor & Destructor Documentation

PopupSurfaceImpl()

Gdk::PopupSurfaceImpl::PopupSurfaceImpl ( PopupSurfaceImpl &&  src )

noexcept

~PopupSurfaceImpl()

Gdk::PopupSurfaceImpl::~PopupSurfaceImpl ( )

overridenoexcept

Member Function Documentation

operator=()

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

noexcept