Struct sourceview5::PrintCompositor

pub struct PrintCompositor { /* private fields */ }

Compose a Buffer for printing.

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

Properties

body-font-name

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 [pango::FontDescription::from_string()][crate::pango::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 PrintCompositorExt::paginate() function.

Readable | Writeable

buffer

The Buffer object to print.

Readable | Writeable | Construct Only

footer-font-name

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 [pango::FontDescription::from_string()][crate::pango::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 PrintCompositorExt::paginate() function.

Readable | Writeable

header-font-name

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 [pango::FontDescription::from_string()][crate::pango::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 PrintCompositorExt::paginate() function.

Readable | Writeable

highlight-syntax

Whether to print the document with highlighted syntax.

The value of this property cannot be changed anymore after the first call to the PrintCompositorExt::paginate() function.

Readable | Writeable

line-numbers-font-name

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 [pango::FontDescription::from_string()][crate::pango::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 PrintCompositorExt::paginate() function.

Readable | Writeable

n-pages

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

Readable

print-footer

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 PrintCompositorExt::paginate() function.

Readable | Writeable

print-header

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 PrintCompositorExt::paginate() function.

Readable | Writeable

print-line-numbers

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 PrintCompositorExt::paginate() function.

Readable | Writeable

tab-width

Width of a tab character expressed in spaces.

The value of this property cannot be changed anymore after the first call to the PrintCompositorExt::paginate() function.

Readable | Writeable

wrap-mode

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 PrintCompositorExt::paginate() function.

Readable | Writeable

Implements

PrintCompositorExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl PrintCompositor

pub const NONE: Option<&'static PrintCompositor> = None

pub fn new(buffer: &impl IsA<Buffer>) -> PrintCompositor

Creates a new print compositor that can be used to print @buffer.

buffer

the #GtkSourceBuffer to print.

Returns

a new print compositor object.

pub fn from_view(view: &impl IsA<View>) -> PrintCompositor

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.

view

a #GtkSourceView to get configuration from.

Returns

a new print compositor object.

pub fn builder() -> PrintCompositorBuilder

Creates a new builder-pattern struct instance to construct PrintCompositor objects.

This method returns an instance of PrintCompositorBuilder which can be used to create PrintCompositor objects.

Trait Implementations

impl Clone for PrintCompositor

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrintCompositor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PrintCompositor

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for PrintCompositor

type ParamSpec = ParamSpecObject

type SetValue = PrintCompositor

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PrintCompositor>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PrintCompositor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PrintCompositor

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PrintCompositor

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for PrintCompositor

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PrintCompositor

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PrintCompositor

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintCompositor