gtkmm: Gdk::CairoContext Class Reference

Cairo draw context. More...

#include <gdkmm/cairocontext.h>

Inheritance diagram for Gdk::CairoContext:

Public Member Functions

 CairoContext (CairoContext&& src) noexcept
 
CairoContextoperator= (CairoContext&& src) noexcept
 
 ~CairoContext () noexcept override
 
GdkCairoContext* gobj ()
 Provides access to the underlying C GObject. More...

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

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

 
::Cairo::RefPtr< ::Cairo::Contextcairo_create ()
 Retrieves a Cairo context to be used to draw on the Gdk::Surface of context. More...

 
- Public Member Functions inherited from Gdk::DrawContext
 DrawContext (DrawContext&& src) noexcept
 
DrawContextoperator= (DrawContext&& src) noexcept
 
 ~DrawContext () noexcept override
 
GdkDrawContext* gobj ()
 Provides access to the underlying C GObject. More...

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

 
GdkDrawContext* 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 ()
 Retrieves the Gdk::Display the context is created for. More...

 
Glib::RefPtr< const Displayget_display () const
 Retrieves the Gdk::Display the context is created for. More...

 
Glib::RefPtr< Surfaceget_surface ()
 Retrieves the Gdk::Surface used by the context. More...

 
Glib::RefPtr< const Surfaceget_surface () const
 Retrieves the Gdk::Surface used by the context. More...

 
void begin_frame (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Indicates that you are beginning the process of redrawing region on the context's surface. More...

 
void end_frame ()
 Ends a drawing operation started with begin_frame() and makes the drawing available on screen. More...

 
bool is_in_frame () const
 Returns true if context is in the process of drawing to its surface after a call to begin_frame() and not yet having called end_frame(). More...

 
::Cairo::RefPtr< const ::Cairo::Regionget_frame_region () const
 Retrieves the region that is currently in the process of being repainted. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > property_display () const
 The Gdk::Display used to create the Gdk::DrawContext. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Surface > > property_surface () const
 The Gdk::Surface the context is bound to. More...

 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

Static Public Member Functions

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::DrawContext
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 CairoContext ()
 
- Protected Member Functions inherited from Gdk::DrawContext
 DrawContext ()
 This constructor is protected because only derived classes shall be instantiated. More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gdk::CairoContextwrap (GdkCairoContext* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

Cairo draw context.

Gdk::CairoContext is an object representing the platform-specific draw context.

Gdk::CairoContexts are created for a Gdk::Display using Gdk::Surface::create_cairo_context(), and the context can then be used to draw on that Gdk::Surface.

Since gtkmm 3.94:

Constructor & Destructor Documentation

Gdk::CairoContext::CairoContext ( CairoContext&&  src)
noexcept
Gdk::CairoContext::~CairoContext ( )
overridenoexcept
Gdk::CairoContext::CairoContext ( )
protected

Member Function Documentation

::Cairo::RefPtr< ::Cairo::Context> Gdk::CairoContext::cairo_create ( )

Retrieves a Cairo context to be used to draw on the Gdk::Surface of context.

A call to Gdk::DrawContext::begin_frame() with this context must have been done or this function will return nullptr.

The returned context is guaranteed to be valid until Gdk::DrawContext::end_frame() is called.

Returns
A Cairo context to be used to draw the contents of the Gdk::Surface. nullptr is returned when context is not drawing.
static GType Gdk::CairoContext::get_type ( )
static

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

GdkCairoContext* Gdk::CairoContext::gobj ( )
inline

Provides access to the underlying C GObject.

const GdkCairoContext* Gdk::CairoContext::gobj ( ) const
inline

Provides access to the underlying C GObject.

GdkCairoContext* Gdk::CairoContext::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

CairoContext& Gdk::CairoContext::operator= ( CairoContext&&  src)
noexcept

Friends And Related Function Documentation

Glib::RefPtr< Gdk::CairoContext > wrap ( GdkCairoContext *  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.