PrintCompositor

class PrintCompositor : ObjectWrap {

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(gtksource.buffer.Buffer buffer): Creates a new print compositor that can be used to print buffer.

Members

Functions

drawPage void drawPage(gtk.print_context.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 glib.global.gfree.

getBottomMargin double getBottomMargin(gtk.types.Unit unit)

Gets the bottom margin in units of unit.

getBuffer gtksource.buffer.Buffer 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 glib.global.gfree.

getHeaderFontName string getHeaderFontName()

Returns the name of the font used to print the page header. The returned string must be freed with glib.global.gfree.

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(gtk.types.Unit 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 glib.global.gfree.

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 gtksource.print_compositor.PrintCompositor.setFooterFormat.

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 gtksource.print_compositor.PrintCompositor.setHeaderFormat.

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(gtk.types.Unit unit)

Gets the right margin in units of unit.

getTabWidth uint getTabWidth()

Returns the width of tabulation in characters for printed text.

getTopMargin double getTopMargin(gtk.types.Unit unit)

Gets the top margin in units of unit.

getWrapMode gtk.types.WrapMode getWrapMode()

Gets the line wrapping mode for the printed text.

paginate bool paginate(gtk.print_context.PrintContext context)

Paginate the document associated with the compositor.

self PrintCompositor self()

Returns this, for use in with statements.

setBodyFontName void setBodyFontName(string fontName)

Sets the default font for the printed text.

setBottomMargin void setBottomMargin(double margin, gtk.types.Unit 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 gtksource.print_compositor.PrintCompositor.setHeaderFormat 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 glib.date_time.DateTime.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, gtk.types.Unit 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 gtksource.print_compositor.PrintCompositor.setFooterFormat.

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 gtksource.print_compositor.PrintCompositor.setHeaderFormat.

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, gtk.types.Unit 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, gtk.types.Unit unit)

Sets the top margin used by compositor.

setWrapMode void setWrapMode(gtk.types.WrapMode wrapMode)

Sets the line wrapping mode for the printed text.

Properties

_gType GType _gType [@property getter]
bodyFontName string bodyFontName [@property getter]: Get bodyFontName property.
bodyFontName string bodyFontName [@property setter]: Set bodyFontName property.
buffer gtksource.buffer.Buffer buffer [@property getter]: Get buffer property.
footerFontName string footerFontName [@property getter]: Get footerFontName property.
footerFontName string footerFontName [@property setter]: Set footerFontName property.
headerFontName string headerFontName [@property getter]: Get headerFontName property.
headerFontName string headerFontName [@property setter]: Set headerFontName property.
highlightSyntax bool highlightSyntax [@property getter]: Get highlightSyntax property.
highlightSyntax bool highlightSyntax [@property setter]: Set highlightSyntax property.
lineNumbersFontName string lineNumbersFontName [@property getter]: Get lineNumbersFontName property.
lineNumbersFontName string lineNumbersFontName [@property setter]: Set lineNumbersFontName property.
nPages int nPages [@property getter]: Get nPages property.
printFooter bool printFooter [@property getter]: Get printFooter property.
printFooter bool printFooter [@property setter]: Set printFooter property.
printHeader bool printHeader [@property getter]: Get printHeader property.
printHeader bool printHeader [@property setter]: Set printHeader property.
printLineNumbers uint printLineNumbers [@property getter]: Get printLineNumbers property.
printLineNumbers uint printLineNumbers [@property setter]: Set printLineNumbers property.
tabWidth uint tabWidth [@property getter]: Get tabWidth property.
tabWidth uint tabWidth [@property setter]: Set tabWidth property.
wrapMode gtk.types.WrapMode wrapMode [@property getter]: Get wrapMode property.
wrapMode gtk.types.WrapMode wrapMode [@property setter]: Set wrapMode property.

Static functions

_getGType GType _getGType()
builder PrintCompositorGidBuilder builder(): Get builder for gtksource.print_compositor.PrintCompositor
newFromView gtksource.print_compositor.PrintCompositor newFromView(gtksource.view.View 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.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.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.
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 gobject.object.ObjectWrap.refSink.
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 gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.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(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
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.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
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(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata 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:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.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 gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.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.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtksource print_compositor classes