SourcePrintCompositor

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

class SourcePrintCompositor : ObjectG {}

Constructors

this
this(GtkSourcePrintCompositor* gtkSourcePrintCompositor)

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. Since 2.2

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 "tab-width", "highlight-syntax", "wrap-mode", "body-font-name" and "print-line-numbers". Since 2.2

Members

Functions

drawPage
void drawPage(PrintContext context, int pageNr)

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 "draw_page" signal

getBodyFontName
string getBodyFontName()

Returns the name of the font used to print the text body. The returned string must be freed with g_free(). Since 2.2

getBottomMargin
double getBottomMargin(GtkUnit unit)

Gets the bottom margin in units of unit. Since 2.2

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. Since 2.2

getFooterFontName
string getFooterFontName()

Returns the name of the font used to print the page footer. The returned string must be freed with g_free()) Since 2.2

getHeaderFontName
string getHeaderFontName()

Returns the name of the font used to print the page header. The returned string must be freed with g_free()) Since 2.2

getHighlightSyntax
int 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. Since 2.2

getLeftMargin
double getLeftMargin(GtkUnit unit)

Gets the left margin in units of unit. Since 2.2

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()) Since 2.2

getNPages
int getNPages()

Returns the number of pages in the document or -1 if the document has not been completely paginated. Since 2.2

getPaginationProgress
double getPaginationProgress()

Returns the current fraction of the document pagination that has been completed. Since 2.2

getPrintFooter
int getPrintFooter()

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 gtk_source_print_compositor_set_footer_format(). Since 2.2

getPrintHeader
int getPrintHeader()

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 gtk_source_print_compositor_set_header_format(). Since 2.2

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). Since 2.2

getRightMargin
double getRightMargin(GtkUnit unit)

Gets the right margin in units of unit. Since 2.2

getSourcePrintCompositorStruct
GtkSourcePrintCompositor* getSourcePrintCompositorStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

getTabWidth
uint getTabWidth()

Returns the width of tabulation in characters for printed text. Since 2.2

getTopMargin
double getTopMargin(GtkUnit unit)

Gets the top margin in units of unit. Since 2.2

getWrapMode
GtkWrapMode getWrapMode()

Gets the line wrapping mode for the printed text. Since 2.2

paginate
int paginate(PrintContext context)

Paginate the document associated with the compositor. In order to support non-blocking pagination, document is paginated in small chunks. Each time gtk_source_print_compositor_paginate() is invoked, a chunk of the document is paginated. To paginate the entire document, gtk_source_print_compositor_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 "paginate" signal, Since 2.2

setBodyFontName
void setBodyFontName(string fontName)

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 pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setBottomMargin
void setBottomMargin(double margin, GtkUnit unit)

Sets the bottom margin used by compositor. Since 2.2

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. font_name should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setFooterFormat
void setFooterFormat(int separator, string left, string center, string right)

Sets strftime like header format strings, to be printed on the left, center and right of the bottom of each page. The strings may include strftime(3) codes which will be expanded at print time. All strftime() codes are accepted, with the addition of N for the page number and Q for the page count. separator specifies if a solid line should be drawn to separate the footer from the document text. If NULL is given for any of the three arguments, that particular string will not be printed. For the footer to be printed, in addition to specifying format strings, you need to enable footer printing with gtk_source_print_compositor_set_print_footer(). This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

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. font_name should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setHeaderFormat
void setHeaderFormat(int 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. All strftime() codes are accepted, with the addition of N for the page number and Q for the page count. 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 gtk_source_print_compositor_set_print_header(). This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setHighlightSyntax
void setHighlightSyntax(int highlight)

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 gtk_source_print_compositor_paginate() function. Since 2.2

setLeftMargin
void setLeftMargin(double margin, GtkUnit unit)

Sets the left margin used by compositor. Since 2.2

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. font_name should be a string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setPrintFooter
void setPrintFooter(int 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(). 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 gtk_source_print_compositor_paginate() function. Since 2.2

setPrintHeader
void setPrintHeader(int 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(). 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 gtk_source_print_compositor_paginate() function. Since 2.2

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). Maximum accepted value for interval is 100. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setRightMargin
void setRightMargin(double margin, GtkUnit unit)

Sets the right margin used by compositor. Since 2.2

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTabWidth
void setTabWidth(uint width)

Sets the width of tabulation in characters for printed text. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

setTopMargin
void setTopMargin(double margin, GtkUnit unit)

Sets the top margin used by compositor. Since 2.2

setWrapMode
void setWrapMode(GtkWrapMode wrapMode)

Sets the line wrapping mode for the printed text. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function. Since 2.2

Variables

gtkSourcePrintCompositor
GtkSourcePrintCompositor* gtkSourcePrintCompositor;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

getObjectGStruct
GObject* getObjectGStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
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.
getDObject
RT getDObject(U obj)

Gets a D Object from the objects table of associations.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, int value)
setProperty
void setProperty(string propertyName, string value)
setProperty
void setProperty(string propertyName, long value)
setProperty
void setProperty(string propertyName, ulong value)
unref
void unref()
Undocumented in source. Be warned that the author may not have intended to support it.
doref
ObjectG doref()
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
onNotifyListeners
void delegate(ParamSpec, ObjectG)[] onNotifyListeners;
Undocumented in source.
addOnNotify
void addOnNotify(void delegate(ParamSpec, ObjectG) dlg, 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. This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the It is important to note that you must use canonical parameter names as detail strings for the notify signal. See Also GParamSpecObject, g_param_spec_object()

callBackNotify
void callBackNotify(GObject* gobjectStruct, GParamSpec* pspec, ObjectG _objectG)
Undocumented in source. Be warned that the author may not have intended to support it.
classInstallProperty
void classInstallProperty(GObjectClass* oclass, uint propertyId, ParamSpec pspec)

Installs a new property. This is usually done in the class initializer. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, e.g. to change the range of allowed values or the default value.

classInstallProperties
void classInstallProperties(GObjectClass* oclass, ParamSpec[] pspecs)

Installs new properties from an array of GParamSpecs. This is usually done in the class initializer. The property id of each property is the index of each GParamSpec in the pspecs array. The property id of 0 is treated specially by GObject and it should not be used to store a GParamSpec. This function should be used if you plan to use a static array of GParamSpecs and g_object_notify_by_pspec(). For instance, this Since 2.26

classFindProperty
ParamSpec classFindProperty(GObjectClass* oclass, string propertyName)

Looks up the GParamSpec for a property of a class.

classListProperties
ParamSpec[] classListProperties(GObjectClass* oclass)

Get an array of GParamSpec* for all properties of a class.

classOverrideProperty
void classOverrideProperty(GObjectClass* oclass, uint propertyId, string name)

Registers property_id as referring to a property with the name name in a parent class or in an interface implemented by oclass. This allows this class to override a property implementation in a parent class or to provide the implementation of a property from an interface. Note Internally, overriding is implemented by creating a property of type GParamSpecOverride; generally operations that query the properties of the object class, such as g_object_class_find_property() or g_object_class_list_properties() will return the overridden property. However, in one case, the construct_properties argument of the constructor virtual function, the GParamSpecOverride is passed instead, so that the param_id field of the GParamSpec will be correct. For virtually all uses, this makes no difference. If you need to get the overridden property, you can call g_param_spec_get_redirect_target(). Since 2.4

interfaceInstallProperty
void interfaceInstallProperty(void* iface, 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. 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. Since 2.4

interfaceFindProperty
ParamSpec interfaceFindProperty(void* iface, 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(). Since 2.4

interfaceListProperties
ParamSpec[] interfaceListProperties(void* iface)

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(). Since 2.4

doref
void* doref(void* object)

Increases the reference count of object.

unref
void unref(void* object)

Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

refSink
void* refSink(void* object)

Increase the reference count of object, and possibly remove the floating 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 2.10

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a GObject. object_ptr must not be NULL. If the reference is NULL then this function does nothing. Otherwise, the reference count of the object is decreased and the pointer is set to NULL. This function is threadsafe and modifies the pointer atomically, using memory barriers where needed. A macro is also included that allows this function to be used without pointer casts. Since 2.28

isFloating
int isFloating(void* object)

Checks whether object has a floating reference. Since 2.10

forceFloating
void forceFloating()

This function is intended for GObject implementations to re-enforce a floating object reference. Doing this is seldomly required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). Since 2.10

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.

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.

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().

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. This functionality is intended for binding object to a proxy object managed by another memory manager. This is done with two paired references: the strong reference added by g_object_add_toggle_ref() and a reverse reference to the proxy object which is either a strong reference or weak reference. The setup is that when there are no other references to object, only a weak reference is held in the reverse direction from object to the proxy object, but when there are other references held to object, a strong reference is held. The notify callback is called when the reference from object to the proxy object should be toggled from strong to weak (is_last_ref true) or weak to strong (is_last_ref false). Since a (normal) reference must be held to the object before calling g_object_toggle_ref(), the initial state of the reverse link is always strong. Multiple toggle references may be added to the same gobject, however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there is important state in the proxy object. Since 2.8

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. Since 2.8

notify
void notify(string propertyName)

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.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

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 Since 2.26

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. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

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, all queued "notify" signals are emitted. It is an error to call this function when the freeze count is zero.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

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. If the object already had an association with that name, the old association will be destroyed.

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. Note that the destroy callback is not called if data is NULL.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

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.

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

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using g_value_init(). 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.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get().

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.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles. This functions should only be called from object system implementations.

Meta