gtkmm  4.8.0
Public Member Functions | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

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

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
}
 Specifies the state of a toplevel surface. More...
 
- 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. More...
 
- 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. More...
 
static Glib::RefPtr< Surfacecreate_toplevel (const Glib::RefPtr< Display > & display)
 Creates a new toplevel surface. More...
 
static Glib::RefPtr< Surfacecreate_popup (const Glib::RefPtr< Surface > & parent, bool autohide)
 Create a new popup surface. More...
 
- Protected Member Functions inherited from Gdk::Toplevel
 Toplevel ()
 You should derive from this class to use it. More...
 

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