SourcePrintCompositor

class SourcePrintCompositor : ObjectG {

}

Constructors

this this(GtkSourcePrintCompositor* gtkSourcePrintCompositor, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(SourceBuffer buffer): Creates a new print compositor that can be used to print @buffer.
this this(SourceView view): 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 #GtkSourcePrintCompositor:tab-width, #GtkSourcePrintCompositor:highlight-syntax, #GtkSourcePrintCompositor:wrap-mode, #GtkSourcePrintCompositor:body-font-name and #GtkSourcePrintCompositor:print-line-numbers.

Members

Functions

drawPage void drawPage(PrintContext context, int pageNr): Draw page @page_nr for printing on the the Cairo context encapsuled in @context.
getBodyFontName string getBodyFontName(): Returns the name of the font used to print the text body. The returned string must be freed with g_free().
getBottomMargin double getBottomMargin(GtkUnit unit): Gets the bottom margin in units of @unit.
getBuffer SourceBuffer getBuffer(): Gets the #GtkSourceBuffer associated with the compositor. The returned object reference is owned by the compositor object and should not be unreferenced.
getFooterFontName string getFooterFontName(): Returns the name of the font used to print the page footer. The returned string must be freed with g_free().
getHeaderFontName string getHeaderFontName(): Returns the name of the font used to print the page header. The returned string must be freed with g_free().
getHighlightSyntax bool getHighlightSyntax(): 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.
getLeftMargin double getLeftMargin(GtkUnit unit): Gets the left margin in units of @unit.
getLineNumbersFontName string getLineNumbersFontName(): Returns the name of the font used to print line numbers on the left margin. The returned string must be freed with g_free().
getNPages int getNPages(): Returns the number of pages in the document or <code>-1</code> if the document has not been completely paginated.
getPaginationProgress double getPaginationProgress(): Returns the current fraction of the document pagination that has been completed.
getPrintFooter bool getPrintFooter(): Determines if a footer is set to be printed for each page. A footer will be printed if this function returns %TRUE <emphasis>and</emphasis> some format strings have been specified with gtk_source_print_compositor_set_footer_format().
getPrintHeader bool getPrintHeader(): Determines if a header is set to be printed for each page. A header will be printed if this function returns %TRUE <emphasis>and</emphasis> some format strings have been specified with gtk_source_print_compositor_set_header_format().
getPrintLineNumbers uint getPrintLineNumbers(): 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).
getRightMargin double getRightMargin(GtkUnit unit): Gets the right margin in units of @unit.
getSourcePrintCompositorStruct GtkSourcePrintCompositor* getSourcePrintCompositorStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getTabWidth uint getTabWidth(): Returns the width of tabulation in characters for printed text.
getTopMargin double getTopMargin(GtkUnit unit): Gets the top margin in units of @unit.
getWrapMode GtkWrapMode getWrapMode(): Gets the line wrapping mode for the printed text.
paginate bool paginate(PrintContext context): Paginate the document associated with the @compositor.
setBodyFontName void setBodyFontName(string fontName): Sets the default font for the printed text.
setBottomMargin void setBottomMargin(double margin, GtkUnit unit): Sets the bottom margin used by @compositor.
setFooterFontName void setFooterFontName(string fontName): 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.
setFooterFormat void setFooterFormat(bool separator, string left, string center, string right): See gtk_source_print_compositor_set_header_format() for more information about the parameters.
setHeaderFontName void setHeaderFontName(string fontName): 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.
setHeaderFormat void setHeaderFormat(bool separator, string left, string center, string right): 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 g_date_time_format() for more details on the accepted format specifiers. Additionally the following format specifiers are accepted: - #N: the page number - #Q: the page count.
setHighlightSyntax void setHighlightSyntax(bool highlight): Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied.
setLeftMargin void setLeftMargin(double margin, GtkUnit unit): Sets the left margin used by @compositor.
setLineNumbersFontName void setLineNumbersFontName(string fontName): 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.
setPrintFooter void setPrintFooter(bool print): 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 gtk_source_print_compositor_set_footer_format().
setPrintHeader void setPrintHeader(bool print): 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 gtk_source_print_compositor_set_header_format().
setPrintLineNumbers void setPrintLineNumbers(uint interval): 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).
setRightMargin void setRightMargin(double margin, GtkUnit unit): Sets the right margin used by @compositor.
setTabWidth void setTabWidth(uint width): Sets the width of tabulation in characters for printed text.
setTopMargin void setTopMargin(double margin, GtkUnit unit): Sets the top margin used by @compositor.
setWrapMode void setWrapMode(GtkWrapMode wrapMode): Sets the line wrapping mode for the printed text.

Static functions

getType GType getType()

Variables

gtkSourcePrintCompositor GtkSourcePrintCompositor* gtkSourcePrintCompositor;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
isGcRoot bool isGcRoot;: Undocumented in source.
signals DClosure[gulong] signals;: Undocumented in source.
destroyNotify void destroyNotify(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify void toggleNotify(ObjectG obj, GObject* object, int isLastRef): Undocumented in source. Be warned that the author may not have intended to support it.
~this ~this(): Undocumented in source.
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
removeGcRoot void removeGcRoot(): Undocumented in source. Be warned that the author may not have intended to support it.
setProperty void setProperty(string propertyName, T value)
unref deprecated void unref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
doref deprecated ObjectG doref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): 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().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): 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.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): 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().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): 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:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): 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().
freezeNotify void freezeNotify(): 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.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): 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.
isFloating bool isFloating(): Checks whether @object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property @property_name on @object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by @pspec on @object.
doref alias doref = ref_: Undocumented in source.
ref_ ObjectG ref_(): Increases the reference count of @object.
refSink ObjectG refSink(): Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): 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"); // retrive the old string list GList *list = g_object_steal_qdata (object, quark_string_list);
thawNotify void thawNotify(): 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.
unref void unref(): Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): 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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a #GObject.