gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::Native Class Reference

Interface for widgets having surfaces. More...

#include <gtkmm/native.h>

Inheritance diagram for Gtk::Native:
Inheritance graph
[legend]

Public Member Functions

 Native (Native && src) noexcept
 
Nativeoperator= (Native && src) noexcept
 
 ~Native () noexcept override
 
GtkNative * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkNative * gobj () const
 Provides access to the underlying C GObject. More...
 
void realize ()
 Realizes a Gtk::Native. More...
 
void unrealize ()
 Unrealizes a Gtk::Native. More...
 
Glib::RefPtr< Gdk::Surfaceget_surface ()
 Returns the surface of this Gtk::Native. More...
 
Glib::RefPtr< const Gdk::Surfaceget_surface () const
 Returns the surface of this Gtk::Native. More...
 
void get_surface_transform (double & x, double & y)
 Retrieves the surface transform of self. More...
 

Static Public Member Functions

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 Nativeget_for_surface (const Glib::RefPtr< const Gdk::Surface > & surface)
 Finds the Gtk::Native associated with the surface. More...
 

Protected Member Functions

 Native ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::Nativewrap (GtkNative * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Interface for widgets having surfaces.

Gtk::Native is the interface implemented by all widgets that can provide a Gdk::Surface for widgets to render on.

The obvious example of a Gtk::Native is Gtk::Window.

See also
Gtk::Root, Gtk::Window
Since gtkmm 3.96:

Constructor & Destructor Documentation

◆ Native() [1/2]

Gtk::Native::Native ( )
protected

You should derive from this class to use it.

◆ Native() [2/2]

Gtk::Native::Native ( Native &&  src)
noexcept

◆ ~Native()

Gtk::Native::~Native ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

static void Gtk::Native::add_interface ( GType  gtype_implementer)
static

◆ get_for_surface()

static Native* Gtk::Native::get_for_surface ( const Glib::RefPtr< const Gdk::Surface > &  surface)
static

Finds the Gtk::Native associated with the surface.

Parameters
surfaceA Gdk::Surface.
Returns
The Gtk::Native that is associated with surface.

◆ get_surface() [1/2]

Glib::RefPtr<Gdk::Surface> Gtk::Native::get_surface ( )

Returns the surface of this Gtk::Native.

Returns
The surface of self.

◆ get_surface() [2/2]

Glib::RefPtr<const Gdk::Surface> Gtk::Native::get_surface ( ) const

Returns the surface of this Gtk::Native.

Returns
The surface of self.

◆ get_surface_transform()

void Gtk::Native::get_surface_transform ( double &  x,
double &  y 
)

Retrieves the surface transform of self.

This is the translation from self's surface coordinates into self's widget coordinates.

Parameters
xReturn location for the x coordinate.
yReturn location for the y coordinate.

◆ get_type()

static GType Gtk::Native::get_type ( )
static

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

◆ gobj() [1/2]

GtkNative* Gtk::Native::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkNative* Gtk::Native::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

Native& Gtk::Native::operator= ( Native &&  src)
noexcept

◆ realize()

void Gtk::Native::realize ( )

Realizes a Gtk::Native.

This should only be used by subclasses.

◆ unrealize()

void Gtk::Native::unrealize ( )

Unrealizes a Gtk::Native.

This should only be used by subclasses.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::Native > wrap ( GtkNative *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.