gtksourceviewmm: Gsv::GutterRenderer Class Reference

gtksourceviewmm 3.12.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gsv::GutterRenderer Class Reference

`#include <gtksourceviewmm/gutterrenderer.h>`

Inheritance diagram for Gsv::GutterRenderer:
[legend]

## Public Member Functions
virtual | ~GutterRenderer ()
GtkSourceGutterRenderer* | gobj ()
| Provides access to the underlying C GtkObject. More...
const GtkSourceGutterRenderer* | gobj () const
| Provides access to the underlying C GtkObject. More...
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. More...
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. More...
void | end ()
| Called when drawing a region of lines has ended. More...
int | get_size () const
| Get the size of the renderer. More...
void | set_size (int size)
| Sets the size of the renderer. More...
bool | get_visible () const
| Get whether the gutter renderer is visible. More...
void | set_visible (bool visible)
| Set whether the gutter renderer is visible. More...
void | get_padding (int& xpad, int& ypad) const
| Get the x-padding and y-padding of the gutter renderer. More...
void | set_padding (int xpad, int ypad)
| Set the padding of the gutter renderer. More...
void | get_alignment (float& xalign, float& yalign) const
| Get the x-alignment and y-alignment of the gutter renderer. More...
void | set_alignment (float xalign, float yalign)
| Set the alignment of the gutter renderer. More...
GutterRendererAlignmentMode | get_alignment_mode () const
| Get the alignment mode. More...
void | set_alignment_mode (GutterRendererAlignmentMode mode)
| Set the alignment mode. More...
Gtk::TextWindowType | get_window_type () const
| Get the Gtk::TextWindowType associated with the gutter renderer. More...
Gtk::TextView* | get_view ()
| Get the view associated to the gutter renderer. More...
const Gtk::TextView* | get_view () const
| Get the view associated to the gutter renderer. More...
bool | get_background (Gdk::RGBA& color) const
| Get the background color of the renderer. More...
bool | is_background_set () const
void | set_background (const Gdk::RGBA& color)
| Set the background color of the renderer. More...
void | queue_draw ()
| Emits the signal_queue_draw() signal of the renderer. More...
Glib::PropertyProxy< bool > | property_visible ()
| Visible. More...
Glib::PropertyProxy_ReadOnly< bool > | property_visible () const
| Visible. More...
Glib::PropertyProxy< int > | property_xpad ()
| The x-padding. More...
Glib::PropertyProxy_ReadOnly< int > | property_xpad () const
| The x-padding. More...
Glib::PropertyProxy< int > | property_ypad ()
| The y-padding. More...
Glib::PropertyProxy_ReadOnly< int > | property_ypad () const
| The y-padding. More...
Glib::PropertyProxy< float > | property_xalign ()
| The x-alignment. More...
Glib::PropertyProxy_ReadOnly< float > | property_xalign () const
| The x-alignment. More...
Glib::PropertyProxy< float > | property_yalign ()
| The y-alignment. More...
Glib::PropertyProxy_ReadOnly< float > | property_yalign () const
| The y-alignment. More...
Glib::PropertyProxy_ReadOnly< Gtk::TextView* > | property_view () const
| The view. More...
Glib::PropertyProxy< GutterRendererAlignmentMode > | property_alignment_mode ()
| The alignment mode. More...
Glib::PropertyProxy_ReadOnly< GutterRendererAlignmentMode > | property_alignment_mode () const
| The alignment mode. More...
Glib::PropertyProxy_ReadOnly< Gtk::TextWindowType > | property_window_type () const
| The window type. More...
Glib::PropertyProxy< int > | property_size ()
| The size. More...
Glib::PropertyProxy_ReadOnly< int > | property_size () const
| The size. More...
Glib::PropertyProxy< Gdk::RGBA > | property_background_rgba ()
| The background color. More...
Glib::PropertyProxy_ReadOnly< Gdk::RGBA > | property_background_rgba () const
| The background color. More...
Glib::PropertyProxy< bool > | property_background_set ()
| Whether the background color is set. More...
Glib::PropertyProxy_ReadOnly< bool > | property_background_set () const
| Whether the background color is set. More...
Glib::SignalProxy5< bool, const Gtk::TextIter&, const Gdk::Rectangle&, int, int, const Glib::RefPtr< Gtk::Tooltip >& > | signal_query_tooltip ()
Glib::SignalProxy3< void, const Gtk::TextIter&, const Gdk::Rectangle&, GdkEvent* > | signal_activate ()
Glib::SignalProxy0< void > | signal_queue_draw ()
Glib::SignalProxy3< void, const Gtk::TextIter&, const Gtk::TextIter&, GutterRendererState > | signal_query_data ()
Glib::SignalProxy3< bool, const Gtk::TextIter&, const Gdk::Rectangle&, GdkEvent* > | signal_query_activatable ()
Public Member Functions inherited from Gtk::Object
virtual | ~Object ()
GObject * | gobj ()
const GObject * | gobj () const
Public Member Functions inherited from Glib::Object
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)
Public Member Functions inherited from Glib::ObjectBase
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
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const 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 ()
| trackable (const trackable &src)
| ~trackable ()
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const
void | notify_callbacks ()
trackable & | operator= (const 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...

## Protected Member Functions
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(). More...
virtual void | on_activate (const Gtk::TextIter& iter, const Gdk::Rectangle& area, GdkEvent* event)
| This is a default handler for the signal signal_activate(). More...
virtual void | on_queue_draw ()
| This is a default handler for the signal signal_queue_draw(). More...
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(). More...
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(). More...
| 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)
Protected Member Functions inherited from Glib::Object
| Object ()
| Object (const Glib::ConstructParams &construct_params)
| Object (GObject *castitem)
Protected Member Functions inherited from Glib::ObjectBase
| ObjectBase ()
| ObjectBase (const char *custom_type_name)
| ObjectBase (const std::type_info &custom_type_info)
virtual | ~ObjectBase ()=0
void | initialize (GObject *castitem)

## Related Functions
(Note that these are not member functions.)
Gsv::GutterRenderer* | wrap (GtkSourceGutterRenderer* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Additional Inherited Members
Public Types inherited from Glib::Object
typedef void(* | DestroyNotify) (gpointer data)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Constructor & Destructor Documentation

virtual Gsv::GutterRenderer::~GutterRenderer | ( |  | ) |
| virtual

Gsv::GutterRenderer::GutterRenderer | ( |  | ) |
| protected

## Member Function Documentation

void Gsv::GutterRenderer::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.

The region to be drawn is indicated by start and end. The purpose is to allow the implementation to precompute some state before the signal_draw() method is called for each cell.

Parameters

  cr | A #cairo_t.
  background_area | A Gdk::Rectangle.
  cell_area | A Gdk::Rectangle.
  start | A Gtk::TextIter.
  end | A Gtk::TextIter.

virtual void Gsv::GutterRenderer::begin_vfunc | ( | const Cairo::RefPtr< Cairo::Context > & | cr,
|  | const Gdk::Rectangle & | background_area,
|  | const Gdk::Rectangle & | cell_area,
|  | Gtk::TextIter & | start,
|  | Gtk::TextIter & | end
| ) |  |
| protectedvirtual

virtual void Gsv::GutterRenderer::change_buffer_vfunc | ( | const Glib::RefPtr< Gtk::TextBuffer > & | old_buffer | ) |
| protectedvirtual

virtual void Gsv::GutterRenderer::change_view_vfunc | ( | Gtk::TextView * | old_view | ) |
| protectedvirtual

void Gsv::GutterRenderer::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.

Implementations should implement this method to draw onto the cairo context. The background_area indicates total area of the cell (without padding or margin) to be drawn. The cell_area indicates the area where content can be drawn (text, images, etc).

The state argument indicates the current state of the renderer and should be taken into account to properly draw the different possible states (cursor, prelit, selected) if appropriate.

Parameters

  cr | The cairo render context.
  background_area | A Gdk::Rectangle indicating the total area to be drawn.
  cell_area | A Gdk::Rectangle indicating the area to draw content.
  start | A Gtk::TextIter.
  end | A Gtk::TextIter.
  state | A Gtk::SourceGutterRendererState.

virtual void Gsv::GutterRenderer::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
| ) |  |
| protectedvirtual

void Gsv::GutterRenderer::end | ( |  | ) |

Called when drawing a region of lines has ended.

virtual void Gsv::GutterRenderer::end_vfunc | ( |  | ) |
| protectedvirtual

void Gsv::GutterRenderer::get_alignment | ( | float & | xalign,
|  | float & | yalign
| ) |  | const

Get the x-alignment and y-alignment of the gutter renderer.

Parameters

  xalign | Return location for the x-alignment (can be `0`).
  yalign | Return location for the y-alignment (can be `0`).

GutterRendererAlignmentMode Gsv::GutterRenderer::get_alignment_mode | ( |  | ) | const

Get the alignment mode.

The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).

Returns
  A Gtk::SourceGutterRendererAlignmentMode.

bool Gsv::GutterRenderer::get_background | ( | Gdk::RGBA & | color | ) | const

Get the background color of the renderer.

Parameters

  color | Return value for a Gdk::RGBA.

Returns
  `true` if the background color is set, `false` otherwise.

void Gsv::GutterRenderer::get_padding | ( | int & | xpad,
|  | int & | ypad
| ) |  | const

Get the x-padding and y-padding of the gutter renderer.

Parameters

  xpad | Return location for the x-padding (can be `0`).
  ypad | Return location for the y-padding (can be `0`).

int Gsv::GutterRenderer::get_size | ( |  | ) | const

Get the size of the renderer.

Returns
  The size of the renderer.

static GType Gsv::GutterRenderer::get_type | ( |  | ) |
| static

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

Gtk::TextView* Gsv::GutterRenderer::get_view | ( |  | ) |

Get the view associated to the gutter renderer.

Returns
  A Gtk::TextView.

const Gtk::TextView* Gsv::GutterRenderer::get_view | ( |  | ) | const

Get the view associated to the gutter renderer.

Returns
  A Gtk::TextView.

bool Gsv::GutterRenderer::get_visible | ( |  | ) | const

Get whether the gutter renderer is visible.

Returns
  `true` if the renderer is visible, `false` otherwise.

Gtk::TextWindowType Gsv::GutterRenderer::get_window_type | ( |  | ) | const

Get the Gtk::TextWindowType associated with the gutter renderer.

Returns
  A Gtk::TextWindowType.

GtkSourceGutterRenderer* Gsv::GutterRenderer::gobj | ( |  | ) |
| inline

Provides access to the underlying C GtkObject.

const GtkSourceGutterRenderer* Gsv::GutterRenderer::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GtkObject.

bool Gsv::GutterRenderer::is_background_set | ( |  | ) | const

virtual void Gsv::GutterRenderer::on_activate | ( | const Gtk::TextIter & | iter,
|  | const Gdk::Rectangle & | area,
|  | GdkEvent * | event
| ) |  |
| protectedvirtual

This is a default handler for the signal signal_activate().

virtual bool Gsv::GutterRenderer::on_query_activatable | ( | const Gtk::TextIter & | iter,
|  | const Gdk::Rectangle & | area,
|  | GdkEvent * | event
| ) |  |
| protectedvirtual

This is a default handler for the signal signal_query_activatable().

virtual void Gsv::GutterRenderer::on_query_data | ( | const Gtk::TextIter & | start,
|  | const Gtk::TextIter & | end,
|  | GutterRendererState | state
| ) |  |
| protectedvirtual

This is a default handler for the signal signal_query_data().

virtual bool Gsv::GutterRenderer::on_query_tooltip | ( | const Gtk::TextIter & | iter,
|  | const Gdk::Rectangle & | area,
|  | int | x,
|  | int | y,
|  | const Glib::RefPtr< Gtk::Tooltip > & | tooltip
| ) |  |
| protectedvirtual

This is a default handler for the signal signal_query_tooltip().

virtual void Gsv::GutterRenderer::on_queue_draw | ( |  | ) |
| protectedvirtual

This is a default handler for the signal signal_queue_draw().

Glib::PropertyProxy< GutterRendererAlignmentMode > Gsv::GutterRenderer::property_alignment_mode | ( |  | ) |

The alignment mode.

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.

Glib::PropertyProxy_ReadOnly< GutterRendererAlignmentMode > Gsv::GutterRenderer::property_alignment_mode | ( |  | ) | const

The alignment mode.

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

Glib::PropertyProxy< Gdk::RGBA > Gsv::GutterRenderer::property_background_rgba | ( |  | ) |

The background color.

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.

Glib::PropertyProxy_ReadOnly< Gdk::RGBA > Gsv::GutterRenderer::property_background_rgba | ( |  | ) | const

The background color.

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

Glib::PropertyProxy< bool > Gsv::GutterRenderer::property_background_set | ( |  | ) |

Whether the background color is set.

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.

Glib::PropertyProxy_ReadOnly< bool > Gsv::GutterRenderer::property_background_set | ( |  | ) | const

Whether the background color is set.

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

Glib::PropertyProxy< int > Gsv::GutterRenderer::property_size | ( |  | ) |

The size.

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.

Glib::PropertyProxy_ReadOnly< int > Gsv::GutterRenderer::property_size | ( |  | ) | const

The size.

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

Glib::PropertyProxy_ReadOnly< Gtk::TextView* > Gsv::GutterRenderer::property_view | ( |  | ) | const

The view.

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

Glib::PropertyProxy< bool > Gsv::GutterRenderer::property_visible | ( |  | ) |

Visible.

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.

Glib::PropertyProxy_ReadOnly< bool > Gsv::GutterRenderer::property_visible | ( |  | ) | const

Visible.

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

Glib::PropertyProxy_ReadOnly< Gtk::TextWindowType > Gsv::GutterRenderer::property_window_type | ( |  | ) | const

The window type.

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

Glib::PropertyProxy< float > Gsv::GutterRenderer::property_xalign | ( |  | ) |

The x-alignment.

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.

Glib::PropertyProxy_ReadOnly< float > Gsv::GutterRenderer::property_xalign | ( |  | ) | const

The x-alignment.

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

Glib::PropertyProxy< int > Gsv::GutterRenderer::property_xpad | ( |  | ) |

The x-padding.

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.

Glib::PropertyProxy_ReadOnly< int > Gsv::GutterRenderer::property_xpad | ( |  | ) | const

The x-padding.

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

Glib::PropertyProxy< float > Gsv::GutterRenderer::property_yalign | ( |  | ) |

The y-alignment.

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.

Glib::PropertyProxy_ReadOnly< float > Gsv::GutterRenderer::property_yalign | ( |  | ) | const

The y-alignment.

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

Glib::PropertyProxy< int > Gsv::GutterRenderer::property_ypad | ( |  | ) |

The y-padding.

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.

Glib::PropertyProxy_ReadOnly< int > Gsv::GutterRenderer::property_ypad | ( |  | ) | const

The y-padding.

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

void Gsv::GutterRenderer::queue_draw | ( |  | ) |

Emits the signal_queue_draw() signal of the renderer.

Call this from an implementation to inform that the renderer has changed such that it needs to redraw.

void Gsv::GutterRenderer::set_alignment | ( | float | xalign,
|  | float | yalign
| ) |  |

Set the alignment of the gutter renderer.

Both xalign and yalign can be -1, which means the values will not be changed (this allows changing only one of the values).

Parameters

  xalign | The x-alignment.
  yalign | The y-alignment.

void Gsv::GutterRenderer::set_alignment_mode | ( | GutterRendererAlignmentMode | mode | ) |

Set the alignment mode.

The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).

Parameters

  mode | A Gtk::SourceGutterRendererAlignmentMode.

void Gsv::GutterRenderer::set_background | ( | const Gdk::RGBA & | color | ) |

Set the background color of the renderer.

If color is set to `0`, the renderer will not have a background color.

Parameters

  color | A Gdk::RGBA or `0`.

void Gsv::GutterRenderer::set_padding | ( | int | xpad,
|  | int | ypad
| ) |  |

Set the padding of the gutter renderer.

Both xpad and ypad can be -1, which means the values will not be changed (this allows changing only one of the values).

Parameters

  xpad | The x-padding.
  ypad | The y-padding.

void Gsv::GutterRenderer::set_size | ( | int | size | ) |

Sets the size of the renderer.

A value of -1 specifies that the size is to be determined dynamically.

Parameters

  size | The size.

void Gsv::GutterRenderer::set_visible | ( | bool | visible | ) |

Set whether the gutter renderer is visible.

Parameters

  visible | The visibility.

Glib::SignalProxy3< void,const Gtk::TextIter&,const Gdk::Rectangle&,GdkEvent* > Gsv::GutterRenderer::signal_activate | ( |  | ) |

Slot Prototype:
  `void on_my_activate(const Gtk::TextIter& iter, const Gdk::Rectangle& area, GdkEvent* event)`

Glib::SignalProxy3< bool,const Gtk::TextIter&,const Gdk::Rectangle&,GdkEvent* > Gsv::GutterRenderer::signal_query_activatable | ( |  | ) |

Slot Prototype:
  `bool on_my_query_activatable(const Gtk::TextIter& iter, const Gdk::Rectangle& area, GdkEvent* event)`

Glib::SignalProxy3< void,const Gtk::TextIter&,const Gtk::TextIter&,GutterRendererState > Gsv::GutterRenderer::signal_query_data | ( |  | ) |

Slot Prototype:
  `void on_my_query_data(const Gtk::TextIter& start, const Gtk::TextIter& end, GutterRendererState state)`

Glib::SignalProxy5< bool,const Gtk::TextIter&,const Gdk::Rectangle&,int,int,const Glib::RefPtr<Gtk::Tooltip>& > Gsv::GutterRenderer::signal_query_tooltip | ( |  | ) |

Slot Prototype:
  `bool on_my_query_tooltip(const Gtk::TextIter& iter, const Gdk::Rectangle& area, int x, int y, const Glib::RefPtr<Gtk::Tooltip>& tooltip)`

Glib::SignalProxy0< void > Gsv::GutterRenderer::signal_queue_draw | ( |  | ) |

Slot Prototype:
  `void on_my_queue_draw()`

## Friends And Related Function Documentation

Gsv::GutterRenderer* wrap | ( | GtkSourceGutterRenderer * | object,
|  | bool | take_copy = `false`
| ) |  |
| related

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

Parameters

  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.

Returns
  A C++ instance that wraps this C instance.