PrintCompositor

Compose a class@Buffer for printing.

The gtksource.print_compositor.PrintCompositor object is used to compose a class@Buffer for printing. You can set various configuration options to customize the printed output. gtksource.print_compositor.PrintCompositor is designed to be used with the high-level printing API of gtk+, i.e. gtk.print_operation.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 gtk.page_setup.PageSetup objects. If the specified layout margins are smaller than the "print margins", the latter ones are used as a fallback by the gtksource.print_compositor.PrintCompositor object, so that the printed area is not clipped.

class PrintCompositor : ObjectG {

this(gtksource.buffer.Buffer buffer);

static gtksource.print_compositor.PrintCompositor newFromView(gtksource.view.View view);

void drawPage(gtk.print_context.PrintContext context, int pageNr);

string getBodyFontName();

double getBottomMargin(gtk.types.Unit unit);

gtksource.buffer.Buffer getBuffer();

string getFooterFontName();

string getHeaderFontName();

bool getHighlightSyntax();

double getLeftMargin(gtk.types.Unit unit);

string getLineNumbersFontName();

int getNPages();

double getPaginationProgress();

bool getPrintFooter();

bool getPrintHeader();

uint getPrintLineNumbers();

double getRightMargin(gtk.types.Unit unit);

uint getTabWidth();

double getTopMargin(gtk.types.Unit unit);

gtk.types.WrapMode getWrapMode();

void ignoreTag(gtk.text_tag.TextTag tag);

bool paginate(gtk.print_context.PrintContext context);

void setBodyFontName(string fontName);

void setBottomMargin(double margin, gtk.types.Unit unit);

void setFooterFontName(string fontName);

void setFooterFormat(bool separator, string left, string center, string right);

void setHeaderFontName(string fontName);

void setHeaderFormat(bool separator, string left, string center, string right);

void setHighlightSyntax(bool highlight);

void setLeftMargin(double margin, gtk.types.Unit unit);

void setLineNumbersFontName(string fontName);

void setPrintFooter(bool print);

void setPrintHeader(bool print);

void setPrintLineNumbers(uint interval);

void setRightMargin(double margin, gtk.types.Unit unit);

void setTabWidth(uint width);

void setTopMargin(double margin, gtk.types.Unit unit);

void setWrapMode(gtk.types.WrapMode wrapMode);

}

Constructors

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.
getBottomMargin double getBottomMargin(gtk.types.Unit unit): Gets the bottom margin in units of unit.
getBuffer gtksource.buffer.Buffer getBuffer(): Gets the classBuffer associated with the compositor.
getFooterFontName string getFooterFontName(): Returns the name of the font used to print the page footer.
getHeaderFontName string getHeaderFontName(): Returns the name of the font used to print the page header.
getHighlightSyntax bool getHighlightSyntax(): Determines whether the printed text will be highlighted according to the buffer rules.
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.
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.
getPrintHeader bool getPrintHeader(): Determines if a header is set to be printed for each page.
getPrintLineNumbers uint getPrintLineNumbers(): Returns the interval used for line number printing.
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.
ignoreTag void ignoreTag(gtk.text_tag.TextTag tag): Specifies a tag whose style should be ignored when compositing the document to the printable page.
paginate bool paginate(gtk.print_context.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, gtk.types.Unit unit): Sets the bottom margin used by compositor.
setFooterFontName void setFooterFontName(string fontName): Sets the font for printing the page footer.
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.
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.
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.
setPrintFooter void setPrintFooter(bool print): Sets whether you want to print a footer in each page.
setPrintHeader void setPrintHeader(bool print): Sets whether you want to print a header in each page.
setPrintLineNumbers void setPrintLineNumbers(uint interval): Sets the interval for printed 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.

Static functions

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.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG 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.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG 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 ulong 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.ObjectG 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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.ref_ and gobject.object.ObjectG.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 ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtksource print_compositor classes

PrintCompositor