The view on which the renderer is placed.
The visibility of the renderer.
The window type of the view on which the renderer is placed (left, or right).
The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment.
The left and right padding of the renderer.
The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment.
The top and bottom padding of the renderer.
Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is called from #GtkSourceGutter and should never have to be called manually.
a #GtkTextIter at the start of the line where the renderer is activated
a #GdkRectangle of the cell area where the renderer is activated
the event that triggered the activation
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 draw method is called for each cell.
a #cairo_t
a #GdkRectangle
a #GdkRectangle
a #GtkTextIter
a #GtkTextIter
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Main renderering method. Implementations should implement this method to draw
onto the cairo context. The background_area indicates the total area of the
cell to be drawn. The cell_area indicates the area where content can be
drawn (text, images, etc).
The background_area is the cell_area plus the padding on each side (two
times the #GtkSourceGutterRenderer:xpad horizontally and two times the
#GtkSourceGutterRenderer:ypad vertically, so that the cell_area is centered
inside background_area).
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.
the cairo render context
a #GdkRectangle indicating the total area to be drawn
a #GdkRectangle indicating the area to draw content
a #GtkTextIter
a #GtkTextIter
a #GtkSourceGutterRendererState
Called when drawing a region of lines has ended.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Get the x-alignment and y-alignment of the gutter renderer.
Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get the x-padding and y-padding of the gutter renderer.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Get the size of the renderer.
Get whether the gutter renderer is visible.
Get the #GtkTextWindowType associated with the gutter renderer.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Get whether the renderer is activatable at the location in event. This is
called from #GtkSourceGutter to determine whether a renderer is activatable
using the mouse pointer.
a #GtkTextIter at the start of the line to be activated
a #GdkRectangle of the cell area to be activated
the event that triggered the query
Emit the #GtkSourceGutterRenderer::query-data signal. This function is called to query for data just before rendering a cell. This is called from the #GtkSourceGutter. Implementations can override the default signal handler or can connect a signal handler externally to the #GtkSourceGutterRenderer::query-data signal.
a #GtkTextIter.
a #GtkTextIter.
a #GtkSourceGutterRendererState.
Emits the #GtkSourceGutterRenderer::query-tooltip signal. This function is called from #GtkSourceGutter. Implementations can override the default signal handler or can connect to the signal externally.
a #GtkTextIter.
a #GdkRectangle.
The x position of the tooltip.
The y position of the tooltip.
a #GtkTooltip.
Emits the #GtkSourceGutterRenderer::queue-draw signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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).
xalign is the horizontal alignment. Set to 0 for a left alignment. 1 for a
right alignment. And 0.5 for centering the cells. yalign is the vertical
alignment. Set to 0 for a top alignment. 1 for a bottom alignment.
the x-alignment
the y-alignment
Set the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).
a #GtkSourceGutterRendererAlignmentMode
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
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).
xpad is the left and right padding. ypad is the top and bottom padding.
the x-padding
the y-padding
Sets a property on an object.
the name of the property to set
the value
Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically.
the size
Sets the folding state of the next cell to be drawn.
This function is intended to be called from a subclass' draw method before chaining-up to its parent's draw method.
a #GtefGutterRendererFoldsState.
Set whether the gutter renderer is visible.
the visibility
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is called from #GtkSourceGutter and should never have to be called manually.
a #GtkTextIter at the start of the line where the renderer is activated
a #GdkRectangle of the cell area where the renderer is activated
the event that triggered the activation
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 draw method is called for each cell.
a #cairo_t
a #GdkRectangle
a #GdkRectangle
a #GtkTextIter
a #GtkTextIter
This is called when the text buffer changes for renderer.
the old #GtkTextBuffer.
Main renderering method. Implementations should implement this method to draw
onto the cairo context. The background_area indicates the total area of the
cell to be drawn. The cell_area indicates the area where content can be
drawn (text, images, etc).
The background_area is the cell_area plus the padding on each side (two
times the #GtkSourceGutterRenderer:xpad horizontally and two times the
#GtkSourceGutterRenderer:ypad vertically, so that the cell_area is centered
inside background_area).
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.
the cairo render context
a #GdkRectangle indicating the total area to be drawn
a #GdkRectangle indicating the area to draw content
a #GtkTextIter
a #GtkTextIter
a #GtkSourceGutterRendererState
Called when drawing a region of lines has ended.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Get whether the renderer is activatable at the location in event. This is
called from #GtkSourceGutter to determine whether a renderer is activatable
using the mouse pointer.
a #GtkTextIter at the start of the line to be activated
a #GdkRectangle of the cell area to be activated
the event that triggered the query
Emit the #GtkSourceGutterRenderer::query-data signal. This function is called to query for data just before rendering a cell. This is called from the #GtkSourceGutter. Implementations can override the default signal handler or can connect a signal handler externally to the #GtkSourceGutterRenderer::query-data signal.
a #GtkTextIter.
a #GtkTextIter.
a #GtkSourceGutterRendererState.
Emits the #GtkSourceGutterRenderer::query-tooltip signal. This function is called from #GtkSourceGutter. Implementations can override the default signal handler or can connect to the signal externally.
a #GtkTextIter.
a #GdkRectangle.
The x position of the tooltip.
The y position of the tooltip.
a #GtkTooltip.
Emits the #GtkSourceGutterRenderer::queue-draw signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
The alignment mode of the renderer. This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping) the alignment should work on either the full cell, the first line or the last line.