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

An interface that supports symbolic colors in paintables. More...

#include <gtkmm/symbolicpaintable.h>

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

Public Member Functions

 SymbolicPaintable (SymbolicPaintable && src) noexcept
 
SymbolicPaintableoperator= (SymbolicPaintable && src) noexcept
 
 ~SymbolicPaintable () noexcept override
 
GtkSymbolicPaintable * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkSymbolicPaintable * gobj () const
 Provides access to the underlying C GObject. More...
 
void snapshot_symbolic (const Glib::RefPtr< Gdk::Snapshot > & snapshot, double width, double height, const std::vector< Gdk::RGBA > & colors)
 Snapshots the paintable with the given colors. 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...
 

Protected Member Functions

 SymbolicPaintable ()
 You should derive from this class to use it. More...
 
virtual void snapshot_symbolic_vfunc (const Glib::RefPtr< Gdk::Snapshot > & snapshot, double width, double height, const std::vector< Gdk::RGBA > & colors)
 

Related Functions

(Note that these are not member functions.)

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

Detailed Description

An interface that supports symbolic colors in paintables.

Gdk::Paintables implementing the interface will have the snapshot_symbolic_vfunc() function called and have the colors for drawing symbolic icons passed. At least 4 colors are guaranteed to be passed every time.

These 4 colors are the foreground color, and the colors to use for errors, warnings and success information in that order.

More colors may be added in the future.

Since gtkmm 4.12:

Constructor & Destructor Documentation

◆ SymbolicPaintable() [1/2]

Gtk::SymbolicPaintable::SymbolicPaintable ( )
protected

You should derive from this class to use it.

◆ SymbolicPaintable() [2/2]

Gtk::SymbolicPaintable::SymbolicPaintable ( SymbolicPaintable &&  src)
noexcept

◆ ~SymbolicPaintable()

Gtk::SymbolicPaintable::~SymbolicPaintable ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

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

◆ get_type()

static GType Gtk::SymbolicPaintable::get_type ( )
static

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

◆ gobj() [1/2]

GtkSymbolicPaintable * Gtk::SymbolicPaintable::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkSymbolicPaintable * Gtk::SymbolicPaintable::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

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

◆ snapshot_symbolic()

void Gtk::SymbolicPaintable::snapshot_symbolic ( const Glib::RefPtr< Gdk::Snapshot > &  snapshot,
double  width,
double  height,
const std::vector< Gdk::RGBA > &  colors 
)

Snapshots the paintable with the given colors.

If less than 4 colors are provided, GTK will pad the vector with default colors.

Since gtkmm 4.12:
Parameters
snapshotA Gdk::Snapshot to snapshot to.
widthWidth to snapshot in.
heightHeight to snapshot in.
colorsA vector of colors.

◆ snapshot_symbolic_vfunc()

virtual void Gtk::SymbolicPaintable::snapshot_symbolic_vfunc ( const Glib::RefPtr< Gdk::Snapshot > &  snapshot,
double  width,
double  height,
const std::vector< Gdk::RGBA > &  colors 
)
protectedvirtual

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::SymbolicPaintable > wrap ( GtkSymbolicPaintable *  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.