Creates a new print compositor that can be used to print buffer.
Name of the font used for the text body.
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
The [classBuffer] object to print.
Name of the font used to print page footer. If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Name of the font used to print page header. If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Whether to print the document with highlighted syntax.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Name of the font used to print line numbers on the left margin. If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
The number of pages in the document or -1 if the
document has not been completely paginated.
Whether to print a footer in each page.
Note that by default the footer format is unspecified, and if it is unspecified the footer will not be printed, regardless of the value of this property.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Whether to print a header in each page.
Note that by default the header format is unspecified, and if it is unspecified the header will not be printed, regardless of the value of this property.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Interval of printed line numbers.
If this property is set to 0 no numbers will be printed. If greater than 0, a number will be printed every "print-line-numbers" lines (i.e. 1 will print all line numbers).
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Width of a tab character expressed in spaces.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
Whether to wrap lines never, at word boundaries, or at character boundaries.
The value of this property cannot be changed anymore after the first
call to the [methodPrintCompositor.paginate] function.
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
Draw page page_nr for printing on the the Cairo context encapsuled in context.
This method has been designed to be called in the handler of the [signalGtk.PrintOperation::draw_page] signal
as shown in the following example:
// Signal handler for the GtkPrintOperation::draw_page signal
static void
draw_page (GtkPrintOperation *operation,
GtkPrintContext *context,
gint page_nr,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
gtk_source_print_compositor_draw_page (compositor,
context,
page_nr);
}
the #GtkPrintContext encapsulating the context information that is required when drawing the page for printing.
the number of the page to print.
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.
Returns the name of the font used to print the text body.
The returned string must be freed with g_free().
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns the name of the font used to print the page footer.
The returned string must be freed with g_free().
Returns the name of the font used to print the page header.
The returned string must be freed with g_free().
Determines whether the printed text will be highlighted according to the buffer rules.
Note that highlighting will happen only if the buffer to print has highlighting activated.
Returns the name of the font used to print line numbers on the left margin.
The returned string must be freed with g_free().
Returns the number of pages in the document or -1 if the
document has not been completely paginated.
Returns the current fraction of the document pagination that has been completed.
Determines if a footer is set to be printed for each page.
A footer will be printed if this function returns %TRUE
and some format strings have been specified
with [methodPrintCompositor.set_footer_format].
Determines if a header is set to be printed for each page.
A header will be printed if this function returns %TRUE
and some format strings have been specified
with [methodPrintCompositor.set_header_format].
Returns the interval used for line number printing.
If the value is 0, no line numbers will be printed. The default value is 1 (i.e. numbers printed in all lines).
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
Returns the width of tabulation in characters for printed text.
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.
Paginate the document associated with the compositor.
In order to support non-blocking pagination, document is paginated in small chunks.
Each time [methodPrintCompositor.paginate] is invoked, a chunk of the document
is paginated. To paginate the entire document, [methodPrintCompositor.paginate]
must be invoked multiple times.
It returns %TRUE if the document has been completely paginated, otherwise it returns %FALSE.
This method has been designed to be invoked in the handler of the [signalGtk.PrintOperation::paginate] signal,
as shown in the following example:
// Signal handler for the GtkPrintOperation::paginate signal
static gboolean
paginate (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
if (gtk_source_print_compositor_paginate (compositor, context))
{
gint n_pages;
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
return TRUE;
}
return FALSE;
}
If you don't need to do pagination in chunks, you can simply do it all in the
[signalGtk.PrintOperation::begin-print] handler, and set the number of pages from there, like
in the following example:
// Signal handler for the GtkPrintOperation::begin-print signal
static void
begin_print (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
gint n_pages;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
while (!gtk_source_print_compositor_paginate (compositor, context));
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
}
the #GtkPrintContext whose parameters (e.g. paper size, print margins, etc.) are used by the the compositor to paginate the document.
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.
Sets the default font for the printed text.
font_name should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
the name of the default font for the body text.
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
Sets the font for printing the page footer.
If %NULL is supplied, the default font (i.e. the one being used for the text) will be used instead.
font_name should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
the name of the font for the footer text, or %NULL.
See [methodPrintCompositor.set_header_format] for more information
about the parameters.
%TRUE if you want a separator line to be printed.
a format string to print on the left of the footer.
a format string to print on the center of the footer.
a format string to print on the right of the footer.
Sets the font for printing the page header.
If %NULL is supplied, the default font (i.e. the one being used for the text) will be used instead.
font_name should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
the name of the font for header text, or %NULL.
Sets strftime like header format strings, to be printed on the left, center and right of the top of each page.
The strings may include strftime(3) codes which will be expanded at print time.
A subset of strftime() codes are accepted, see [methodGLib.DateTime.format]
for more details on the accepted format specifiers.
Additionally the following format specifiers are accepted:
separator specifies if a solid line should be drawn to separate
the header from the document text.
If %NULL is given for any of the three arguments, that particular string will not be printed.
For the header to be printed, in
addition to specifying format strings, you need to enable header
printing with [methodPrintCompositor.set_print_header].
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
%TRUE if you want a separator line to be printed.
a format string to print on the left of the header.
a format string to print on the center of the header.
a format string to print on the right of the header.
Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
whether syntax should be highlighted.
Sets the font for printing line numbers on the left margin.
If %NULL is supplied, the default font (i.e. the one being used for the text) will be used instead.
font_name should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See [funcPango.FontDescription.from_string]
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
the name of the font for line numbers, or %NULL.
Sets whether you want to print a footer in each page.
The footer consists of three pieces of text and an optional line
separator, configurable with
[methodPrintCompositor.set_footer_format].
Note that by default the footer format is unspecified, and if it's empty it will not be printed, regardless of this setting.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
%TRUE if you want the footer to be printed.
Sets whether you want to print a header in each page.
The header consists of three pieces of text and an optional line
separator, configurable with [methodPrintCompositor.set_header_format].
Note that by default the header format is unspecified, and if it's empty it will not be printed, regardless of this setting.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
%TRUE if you want the header to be printed.
Sets the interval for printed line numbers.
If interval is 0 no numbers will be printed. If greater than 0, a number will be
printed every interval lines (i.e. 1 will print all line numbers).
Maximum accepted value for interval is 100.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
interval for printed line numbers.
Sets a property on an object.
the name of the property to set
the value
Sets the width of tabulation in characters for printed text.
This function cannot be called anymore after the first call to the
[methodPrintCompositor.paginate] function.
width of tab in characters.
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 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.
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 print compositor that can be used to print buffer.
Creates a new print compositor that can be used to print the buffer
associated with view.
This constructor sets some configuration properties to make the
printed output match view as much as possible. The properties set are
[propertyPrintCompositor:tab-width], [propertyPrintCompositor:highlight-syntax],
[propertyPrintCompositor:wrap-mode], [propertyPrintCompositor:body-font-name] and
[propertyPrintCompositor:print-line-numbers].
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
Compose a [class
Buffer]for printing.The
GtkSourcePrintCompositorobject is used to compose a [classBuffer]for printing. You can set various configuration options to customize the printed output.GtkSourcePrintCompositoris designed to be used with the high-level printing API of gtk+, i.e. [classGtk.PrintOperation].The margins specified in this object are the layout margins: they define the blank space bordering the printed area of the pages. They must not be confused with the "print margins", i.e. the parts of the page that the printer cannot print on, defined in the [class
Gtk.PageSetup] objects. If the specified layout margins are smaller than the "print margins", the latter ones are used as a fallback by theGtkSourcePrintCompositorobject, so that the printed area is not clipped.