gtksourceviewmm 3.18.0
Gsv::GutterRendererPixbuf Class Reference

#include <gtksourceviewmm/gutterrendererpixbuf.h>

Inheritance diagram for Gsv::GutterRendererPixbuf:

Public Member Functions

 GutterRendererPixbuf (GutterRendererPixbuf&& src) noexcept
 
GutterRendererPixbufoperator= (GutterRendererPixbuf&& src) noexcept
 
 GutterRendererPixbuf (const GutterRendererPixbuf&)=delete
 
GutterRendererPixbufoperator= (const GutterRendererPixbuf&)=delete
 
 ~GutterRendererPixbuf () noexcept override
 
GtkSourceGutterRendererPixbuf* gobj ()
 Provides access to the underlying C GObject.
 
const GtkSourceGutterRendererPixbuf* gobj () const
 Provides access to the underlying C GObject.
 
 GutterRendererPixbuf ()
 
Glib::RefPtr< Gdk::Pixbufget_pixbuf ()
 Get the pixbuf of the renderer.
 
Glib::RefPtr< const Gdk::Pixbufget_pixbuf () const
 Get the pixbuf of the renderer.
 
void set_pixbuf (const Glib::RefPtr< const Gdk::Pixbuf >& pixbuf)
 
std::string get_stock_id () const
 
void set_stock_id (const std::string& stock_id)
 
Glib::RefPtr< Gio::Icon > get_icon ()
 Get the gicon of the renderer.
 
Glib::RefPtr< const Gio::Icon > get_icon () const
 Get the gicon of the renderer.
 
void set_icon (const Glib::RefPtr< Gio::Icon >& icon)
 
std::string get_icon_name () const
 
void set_icon_name (const std::string& icon_name)
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf ()
 The pixbuf.
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf () const
 The pixbuf.
 
Glib::PropertyProxy< std::stringproperty_stock_id ()
 The stock id.
 
Glib::PropertyProxy_ReadOnly< std::stringproperty_stock_id () const
 The stock id.
 
Glib::PropertyProxy< std::stringproperty_icon_name ()
 The icon name.
 
Glib::PropertyProxy_ReadOnly< std::stringproperty_icon_name () const
 The icon name.
 
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > property_gicon ()
 The gicon.
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > property_gicon () const
 The gicon.
 
- Public Member Functions inherited from Gsv::GutterRenderer
 GutterRenderer (GutterRenderer&& src) noexcept
 
GutterRendereroperator= (GutterRenderer&& src) noexcept
 
 GutterRenderer (const GutterRenderer&)=delete
 
GutterRendereroperator= (const GutterRenderer&)=delete
 
 ~GutterRenderer () noexcept override
 
GtkSourceGutterRenderer* gobj ()
 Provides access to the underlying C GObject.
 
const GtkSourceGutterRenderer* gobj () const
 Provides access to the underlying C GObject.
 
void begin (const Cairo::RefPtr< Cairo::Context >& cr, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, Gtk::TextIter&start, Gtk::TextIter&end)
 Called when drawing a region begins.
 
void draw (const Cairo::RefPtr< Cairo::Context >& cr, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, Gtk::TextIter&start, Gtk::TextIter&end, GutterRendererState p6)
 Main renderering method.
 
void end ()
 Called when drawing a region of lines has ended.
 
int get_size () const
 Get the size of the renderer.
 
void set_size (int size)
 Sets the size of the renderer.
 
bool get_visible () const
 Get whether the gutter renderer is visible.
 
void set_visible (bool visible)
 Set whether the gutter renderer is visible.
 
void get_padding (int& xpad, int& ypad) const
 Get the x-padding and y-padding of the gutter renderer.
 
void set_padding (int xpad, int ypad)
 Set the padding of the gutter renderer.
 
void get_alignment (float& xalign, float& yalign) const
 Get the x-alignment and y-alignment of the gutter renderer.
 
void set_alignment (float xalign, float yalign)
 Set the alignment of the gutter renderer.
 
GutterRendererAlignmentMode get_alignment_mode () const
 Get the alignment mode.
 
void set_alignment_mode (GutterRendererAlignmentMode mode)
 Set the alignment mode.
 
Gtk::TextWindowType get_window_type () const
 Get the Gtk::TextWindowType associated with the gutter renderer.
 
Gtk::TextViewget_view ()
 Get the view associated to the gutter renderer.
 
const Gtk::TextViewget_view () const
 Get the view associated to the gutter renderer.
 
bool get_background (Gdk::RGBA& color) const
 Get the background color of the renderer.
 
bool is_background_set () const
 
void set_background (const Gdk::RGBA& color)
 Set the background color of the renderer.
 
void queue_draw ()
 Emits the signal_queue_draw() signal of the renderer.
 
Glib::PropertyProxy< bool > property_visible ()
 Visible.
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Visible.
 
Glib::PropertyProxy< int > property_xpad ()
 The x-padding.
 
Glib::PropertyProxy_ReadOnly< int > property_xpad () const
 The x-padding.
 
Glib::PropertyProxy< int > property_ypad ()
 The y-padding.
 
Glib::PropertyProxy_ReadOnly< int > property_ypad () const
 The y-padding.
 
Glib::PropertyProxy< float > property_xalign ()
 The x-alignment.
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 The x-alignment.
 
Glib::PropertyProxy< float > property_yalign ()
 The y-alignment.
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 The y-alignment.
 
Glib::PropertyProxy_ReadOnly< Gtk::TextView* > property_view () const
 The view.
 
Glib::PropertyProxy< GutterRendererAlignmentModeproperty_alignment_mode ()
 The alignment mode.
 
Glib::PropertyProxy_ReadOnly< GutterRendererAlignmentModeproperty_alignment_mode () const
 The alignment mode.
 
Glib::PropertyProxy_ReadOnly< Gtk::TextWindowTypeproperty_window_type () const
 The window type.
 
Glib::PropertyProxy< int > property_size ()
 The size.
 
Glib::PropertyProxy_ReadOnly< int > property_size () const
 The size.
 
Glib::PropertyProxy< Gdk::RGBAproperty_background_rgba ()
 The background color.
 
Glib::PropertyProxy_ReadOnly< Gdk::RGBAproperty_background_rgba () const
 The background color.
 
Glib::PropertyProxy< bool > property_background_set ()
 Whether the background color is set.
 
Glib::PropertyProxy_ReadOnly< bool > property_background_set () const
 Whether the background color is set.
 
Glib::SignalProxy< bool, const Gtk::TextIter&, const Gdk::Rectangle&, int, int, const Glib::RefPtr< Gtk::Tooltip >& > signal_query_tooltip ()
 
Glib::SignalProxy< void, const Gtk::TextIter&, const Gdk::Rectangle&, GdkEvent* > signal_activate ()
 
Glib::SignalProxy< void > signal_queue_draw ()
 
Glib::SignalProxy< void, const Gtk::TextIter&, const Gtk::TextIter&, GutterRendererStatesignal_query_data ()
 
Glib::SignalProxy< bool, const Gtk::TextIter&, const Gdk::Rectangle&, GdkEvent* > signal_query_activatable ()
 
- Public Member Functions inherited from Gtk::Object
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
 ~Object () noexcept override
 
GObject * gobj ()
 
const GObject * gobj () const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
- Static Public Member Functions inherited from Gsv::GutterRenderer
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 

Related Symbols

(Note that these are not member symbols.)

Gsv::GutterRendererPixbufwrap (GtkSourceGutterRendererPixbuf* object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Additional Inherited Members

- Protected Member Functions inherited from Gsv::GutterRenderer
virtual bool on_query_tooltip (const Gtk::TextIter& iter, const Gdk::Rectangle& area, int x, int y, const Glib::RefPtr< Gtk::Tooltip >& tooltip)
 This is a default handler for the signal signal_query_tooltip().
 
virtual void on_activate (const Gtk::TextIter& iter, const Gdk::Rectangle& area, GdkEvent* event)
 This is a default handler for the signal signal_activate().
 
virtual void on_queue_draw ()
 This is a default handler for the signal signal_queue_draw().
 
virtual void on_query_data (const Gtk::TextIter&start, const Gtk::TextIter&end, GutterRendererState state)
 This is a default handler for the signal signal_query_data().
 
virtual bool on_query_activatable (const Gtk::TextIter& iter, const Gdk::Rectangle& area, GdkEvent* event)
 This is a default handler for the signal signal_query_activatable().
 
 GutterRenderer ()
 
virtual void begin_vfunc (const Cairo::RefPtr< Cairo::Context >& cr, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, Gtk::TextIter&start, Gtk::TextIter&end)
 
virtual void draw_vfunc (const Cairo::RefPtr< Cairo::Context >& cr, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, Gtk::TextIter&start, Gtk::TextIter&end, GutterRendererState p6)
 
virtual void end_vfunc ()
 
virtual void change_view_vfunc (Gtk::TextView* old_view)
 
virtual void change_buffer_vfunc (const Glib::RefPtr< Gtk::TextBuffer >& old_buffer)
 

Constructor & Destructor Documentation

◆ GutterRendererPixbuf() [1/3]

Gsv::GutterRendererPixbuf::GutterRendererPixbuf ( GutterRendererPixbuf&& src)
noexcept

◆ GutterRendererPixbuf() [2/3]

Gsv::GutterRendererPixbuf::GutterRendererPixbuf ( const GutterRendererPixbuf& )
delete

◆ ~GutterRendererPixbuf()

Gsv::GutterRendererPixbuf::~GutterRendererPixbuf ( )
overridenoexcept

◆ GutterRendererPixbuf() [3/3]

Gsv::GutterRendererPixbuf::GutterRendererPixbuf ( )

Member Function Documentation

◆ get_icon() [1/2]

Glib::RefPtr< Gio::Icon > Gsv::GutterRendererPixbuf::get_icon ( )

Get the gicon of the renderer.

Returns
A Icon.

◆ get_icon() [2/2]

Glib::RefPtr< const Gio::Icon > Gsv::GutterRendererPixbuf::get_icon ( ) const

Get the gicon of the renderer.

Returns
A Icon.

◆ get_icon_name()

std::string Gsv::GutterRendererPixbuf::get_icon_name ( ) const

◆ get_pixbuf() [1/2]

Glib::RefPtr< Gdk::Pixbuf > Gsv::GutterRendererPixbuf::get_pixbuf ( )

Get the pixbuf of the renderer.

Returns
A Gdk::Pixbuf.

◆ get_pixbuf() [2/2]

Glib::RefPtr< const Gdk::Pixbuf > Gsv::GutterRendererPixbuf::get_pixbuf ( ) const

Get the pixbuf of the renderer.

Returns
A Gdk::Pixbuf.

◆ get_stock_id()

std::string Gsv::GutterRendererPixbuf::get_stock_id ( ) const

◆ get_type()

static GType Gsv::GutterRendererPixbuf::get_type ( )
static

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

◆ gobj() [1/2]

GtkSourceGutterRendererPixbuf * Gsv::GutterRendererPixbuf::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkSourceGutterRendererPixbuf * Gsv::GutterRendererPixbuf::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=() [1/2]

GutterRendererPixbuf& Gsv::GutterRendererPixbuf::operator= ( const GutterRendererPixbuf& )
delete

◆ operator=() [2/2]

GutterRendererPixbuf& Gsv::GutterRendererPixbuf::operator= ( GutterRendererPixbuf&& src)
noexcept

◆ property_gicon() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > Gsv::GutterRendererPixbuf::property_gicon ( )

The gicon.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_gicon() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > Gsv::GutterRendererPixbuf::property_gicon ( ) const

The gicon.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_icon_name() [1/2]

Glib::PropertyProxy< std::string > Gsv::GutterRendererPixbuf::property_icon_name ( )

The icon name.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_icon_name() [2/2]

Glib::PropertyProxy_ReadOnly< std::string > Gsv::GutterRendererPixbuf::property_icon_name ( ) const

The icon name.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_pixbuf() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > Gsv::GutterRendererPixbuf::property_pixbuf ( )

The pixbuf.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_pixbuf() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > Gsv::GutterRendererPixbuf::property_pixbuf ( ) const

The pixbuf.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_stock_id() [1/2]

Glib::PropertyProxy< std::string > Gsv::GutterRendererPixbuf::property_stock_id ( )

The stock id.

Deprecated
This should not be used in newly-written code.
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_stock_id() [2/2]

Glib::PropertyProxy_ReadOnly< std::string > Gsv::GutterRendererPixbuf::property_stock_id ( ) const

The stock id.

Deprecated
This should not be used in newly-written code.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_icon()

void Gsv::GutterRendererPixbuf::set_icon ( const Glib::RefPtr< Gio::Icon > & icon)

◆ set_icon_name()

void Gsv::GutterRendererPixbuf::set_icon_name ( const std::string & icon_name)

◆ set_pixbuf()

void Gsv::GutterRendererPixbuf::set_pixbuf ( const Glib::RefPtr< const Gdk::Pixbuf > & pixbuf)

◆ set_stock_id()

void Gsv::GutterRendererPixbuf::set_stock_id ( const std::string & stock_id)

Friends And Related Symbol Documentation

◆ wrap()

Gsv::GutterRendererPixbuf* wrap ( GtkSourceGutterRendererPixbuf * 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.