gtkmm
3.89.5.1
|
Drawing context for GDK windows. More...
#include <gdkmm/drawingcontext.h>
Public Member Functions | |
DrawingContext (DrawingContext&& src) noexcept | |
DrawingContext& | operator= (DrawingContext&& src) noexcept |
~DrawingContext () noexceptoverride | |
GdkDrawingContext* | gobj () |
Provides access to the underlying C GObject. More... | |
const GdkDrawingContext* | gobj () const |
Provides access to the underlying C GObject. More... | |
GdkDrawingContext* | 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< Window > | get_window () |
Retrieves the window that created the drawing context. More... | |
Glib::RefPtr< const Window > | get_window () const |
Retrieves the window that created the drawing context. More... | |
Glib::RefPtr< DrawContext > | get_paint_context () |
Retrieves the paint context used to draw with. More... | |
Glib::RefPtr< const DrawContext > | get_paint_context () const |
Retrieves the paint context used to draw with. More... | |
::Cairo::RefPtr< ::Cairo::Region > | get_clip () const |
Retrieves a copy of the clip region used when creating the context. More... | |
bool | is_valid () const |
Checks whether the given Gdk::DrawingContext is valid. More... | |
::Cairo::RefPtr< ::Cairo::Context > | get_cairo_context () |
Retrieves a Cairo context to be used to draw on the Gdk::Window that created the Gdk::DrawingContext. More... | |
::Cairo::RefPtr< const ::Cairo::Context > | get_cairo_context () const |
Retrieves a Cairo context to be used to draw on the Gdk::Window that created the Gdk::DrawingContext. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Window > > | property_window () const |
The Gdk::Window that created the drawing context. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< DrawContext > > | property_paint_context () const |
The Gdk::DrawContext used to draw or nullptr if Cairo is used. More... | |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (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::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (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 |
![]() | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *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 Glib::RefPtr< DrawingContext > | get_drawing_context_from_cairo_context (const ::Cairo::RefPtr< ::Cairo::Context >& cr) |
Retrieves the Gdk::DrawingContext that created the Cairo context cr. More... | |
Protected Member Functions | |
DrawingContext () | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexceptoverride | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (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::DrawingContext > | wrap (GdkDrawingContext* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Drawing context for GDK windows.
Gdk::DrawingContext is an object that represents the current drawing state of a Gdk::Window.
It's possible to use a Gdk::DrawingContext to draw on a Gdk::Window via rendering API like Cairo or OpenGL.
A Gdk::DrawingContext can only be created by calling Gdk::Window::begin_draw_frame() and will be valid until a call to Gdk::Window::end_draw_frame().
|
noexcept |
|
overridenoexcept |
|
protected |
::Cairo::RefPtr< ::Cairo::Context> Gdk::DrawingContext::get_cairo_context | ( | ) |
Retrieves a Cairo context to be used to draw on the Gdk::Window that created the Gdk::DrawingContext.
The context must have been created without a Gdk::DrawContext for this function to work. If get_paint_context() does not return nullptr
, then this function will.
The returned context is guaranteed to be valid as long as the Gdk::DrawingContext is valid, that is between a call to Gdk::Window::begin_draw_frame() and Gdk::Window::end_draw_frame().
nullptr
is returned when a paint context is in used. ::Cairo::RefPtr<const ::Cairo::Context> Gdk::DrawingContext::get_cairo_context | ( | ) | const |
Retrieves a Cairo context to be used to draw on the Gdk::Window that created the Gdk::DrawingContext.
The context must have been created without a Gdk::DrawContext for this function to work. If get_paint_context() does not return nullptr
, then this function will.
The returned context is guaranteed to be valid as long as the Gdk::DrawingContext is valid, that is between a call to Gdk::Window::begin_draw_frame() and Gdk::Window::end_draw_frame().
nullptr
is returned when a paint context is in used. ::Cairo::RefPtr< ::Cairo::Region> Gdk::DrawingContext::get_clip | ( | ) | const |
Retrieves a copy of the clip region used when creating the context.
|
static |
Retrieves the Gdk::DrawingContext that created the Cairo context cr.
cr | A Cairo context. |
Glib::RefPtr<DrawContext> Gdk::DrawingContext::get_paint_context | ( | ) |
Retrieves the paint context used to draw with.
nullptr
. Glib::RefPtr<const DrawContext> Gdk::DrawingContext::get_paint_context | ( | ) | const |
Retrieves the paint context used to draw with.
nullptr
.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
Glib::RefPtr<Window> Gdk::DrawingContext::get_window | ( | ) |
Glib::RefPtr<const Window> Gdk::DrawingContext::get_window | ( | ) | const |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GdkDrawingContext* Gdk::DrawingContext::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gdk::DrawingContext::is_valid | ( | ) | const |
Checks whether the given Gdk::DrawingContext is valid.
true
if the context is valid.
|
noexcept |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<DrawContext> > Gdk::DrawingContext::property_paint_context | ( | ) | const |
The Gdk::DrawContext used to draw or nullptr
if Cairo is used.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Window> > Gdk::DrawingContext::property_window | ( | ) | const |
The Gdk::Window that created the drawing context.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |