| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GtkSource.Objects.PrintCompositor
Contents
- Exported types
- Methods
- drawPage
- getBodyFontName
- getBottomMargin
- getBuffer
- getFooterFontName
- getHeaderFontName
- getHighlightSyntax
- getLeftMargin
- getLineNumbersFontName
- getNPages
- getPaginationProgress
- getPrintFooter
- getPrintHeader
- getPrintLineNumbers
- getRightMargin
- getTabWidth
- getTopMargin
- getWrapMode
- new
- newFromView
- paginate
- setBodyFontName
- setBottomMargin
- setFooterFontName
- setFooterFormat
- setHeaderFontName
- setHeaderFormat
- setHighlightSyntax
- setLeftMargin
- setLineNumbersFontName
- setPrintFooter
- setPrintHeader
- setPrintLineNumbers
- setRightMargin
- setTabWidth
- setTopMargin
- setWrapMode
- Properties
Description
- newtype PrintCompositor = PrintCompositor (ManagedPtr PrintCompositor)
- class GObject o => IsPrintCompositor o
- toPrintCompositor :: IsPrintCompositor o => o -> IO PrintCompositor
- noPrintCompositor :: Maybe PrintCompositor
- data PrintCompositorDrawPageMethodInfo
- printCompositorDrawPage :: (HasCallStack, MonadIO m, IsPrintCompositor a, IsPrintContext b) => a -> b -> Int32 -> m ()
- data PrintCompositorGetBodyFontNameMethodInfo
- printCompositorGetBodyFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Text
- data PrintCompositorGetBottomMarginMethodInfo
- printCompositorGetBottomMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Unit -> m Double
- data PrintCompositorGetBufferMethodInfo
- printCompositorGetBuffer :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Buffer
- data PrintCompositorGetFooterFontNameMethodInfo
- printCompositorGetFooterFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Text
- data PrintCompositorGetHeaderFontNameMethodInfo
- printCompositorGetHeaderFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Text
- data PrintCompositorGetHighlightSyntaxMethodInfo
- printCompositorGetHighlightSyntax :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Bool
- data PrintCompositorGetLeftMarginMethodInfo
- printCompositorGetLeftMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Unit -> m Double
- data PrintCompositorGetLineNumbersFontNameMethodInfo
- printCompositorGetLineNumbersFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Text
- data PrintCompositorGetNPagesMethodInfo
- printCompositorGetNPages :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Int32
- data PrintCompositorGetPaginationProgressMethodInfo
- printCompositorGetPaginationProgress :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Double
- data PrintCompositorGetPrintFooterMethodInfo
- printCompositorGetPrintFooter :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Bool
- data PrintCompositorGetPrintHeaderMethodInfo
- printCompositorGetPrintHeader :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Bool
- data PrintCompositorGetPrintLineNumbersMethodInfo
- printCompositorGetPrintLineNumbers :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Word32
- data PrintCompositorGetRightMarginMethodInfo
- printCompositorGetRightMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Unit -> m Double
- data PrintCompositorGetTabWidthMethodInfo
- printCompositorGetTabWidth :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m Word32
- data PrintCompositorGetTopMarginMethodInfo
- printCompositorGetTopMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Unit -> m Double
- data PrintCompositorGetWrapModeMethodInfo
- printCompositorGetWrapMode :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> m WrapMode
- printCompositorNew :: (HasCallStack, MonadIO m, IsBuffer a) => a -> m PrintCompositor
- printCompositorNewFromView :: (HasCallStack, MonadIO m, IsView a) => a -> m PrintCompositor
- data PrintCompositorPaginateMethodInfo
- printCompositorPaginate :: (HasCallStack, MonadIO m, IsPrintCompositor a, IsPrintContext b) => a -> b -> m Bool
- data PrintCompositorSetBodyFontNameMethodInfo
- printCompositorSetBodyFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Text -> m ()
- data PrintCompositorSetBottomMarginMethodInfo
- printCompositorSetBottomMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Double -> Unit -> m ()
- data PrintCompositorSetFooterFontNameMethodInfo
- printCompositorSetFooterFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Maybe Text -> m ()
- data PrintCompositorSetFooterFormatMethodInfo
- printCompositorSetFooterFormat :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Bool -> Maybe Text -> Maybe Text -> Maybe Text -> m ()
- data PrintCompositorSetHeaderFontNameMethodInfo
- printCompositorSetHeaderFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Maybe Text -> m ()
- data PrintCompositorSetHeaderFormatMethodInfo
- printCompositorSetHeaderFormat :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Bool -> Maybe Text -> Maybe Text -> Maybe Text -> m ()
- data PrintCompositorSetHighlightSyntaxMethodInfo
- printCompositorSetHighlightSyntax :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Bool -> m ()
- data PrintCompositorSetLeftMarginMethodInfo
- printCompositorSetLeftMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Double -> Unit -> m ()
- data PrintCompositorSetLineNumbersFontNameMethodInfo
- printCompositorSetLineNumbersFontName :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Maybe Text -> m ()
- data PrintCompositorSetPrintFooterMethodInfo
- printCompositorSetPrintFooter :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Bool -> m ()
- data PrintCompositorSetPrintHeaderMethodInfo
- printCompositorSetPrintHeader :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Bool -> m ()
- data PrintCompositorSetPrintLineNumbersMethodInfo
- printCompositorSetPrintLineNumbers :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Word32 -> m ()
- data PrintCompositorSetRightMarginMethodInfo
- printCompositorSetRightMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Double -> Unit -> m ()
- data PrintCompositorSetTabWidthMethodInfo
- printCompositorSetTabWidth :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Word32 -> m ()
- data PrintCompositorSetTopMarginMethodInfo
- printCompositorSetTopMargin :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> Double -> Unit -> m ()
- data PrintCompositorSetWrapModeMethodInfo
- printCompositorSetWrapMode :: (HasCallStack, MonadIO m, IsPrintCompositor a) => a -> WrapMode -> m ()
- data PrintCompositorBodyFontNamePropertyInfo
- constructPrintCompositorBodyFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o)
- getPrintCompositorBodyFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text)
- printCompositorBodyFontName :: AttrLabelProxy "bodyFontName"
- setPrintCompositorBodyFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m ()
- data PrintCompositorBufferPropertyInfo
- constructPrintCompositorBuffer :: (IsPrintCompositor o, IsBuffer a) => a -> IO (GValueConstruct o)
- getPrintCompositorBuffer :: (MonadIO m, IsPrintCompositor o) => o -> m Buffer
- printCompositorBuffer :: AttrLabelProxy "buffer"
- data PrintCompositorFooterFontNamePropertyInfo
- clearPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> m ()
- constructPrintCompositorFooterFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o)
- getPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text)
- printCompositorFooterFontName :: AttrLabelProxy "footerFontName"
- setPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m ()
- data PrintCompositorHeaderFontNamePropertyInfo
- clearPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> m ()
- constructPrintCompositorHeaderFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o)
- getPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text)
- printCompositorHeaderFontName :: AttrLabelProxy "headerFontName"
- setPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m ()
- data PrintCompositorHighlightSyntaxPropertyInfo
- constructPrintCompositorHighlightSyntax :: IsPrintCompositor o => Bool -> IO (GValueConstruct o)
- getPrintCompositorHighlightSyntax :: (MonadIO m, IsPrintCompositor o) => o -> m Bool
- printCompositorHighlightSyntax :: AttrLabelProxy "highlightSyntax"
- setPrintCompositorHighlightSyntax :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m ()
- data PrintCompositorLineNumbersFontNamePropertyInfo
- clearPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> m ()
- constructPrintCompositorLineNumbersFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o)
- getPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text)
- printCompositorLineNumbersFontName :: AttrLabelProxy "lineNumbersFontName"
- setPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m ()
- data PrintCompositorNPagesPropertyInfo
- getPrintCompositorNPages :: (MonadIO m, IsPrintCompositor o) => o -> m Int32
- printCompositorNPages :: AttrLabelProxy "nPages"
- data PrintCompositorPrintFooterPropertyInfo
- constructPrintCompositorPrintFooter :: IsPrintCompositor o => Bool -> IO (GValueConstruct o)
- getPrintCompositorPrintFooter :: (MonadIO m, IsPrintCompositor o) => o -> m Bool
- printCompositorPrintFooter :: AttrLabelProxy "printFooter"
- setPrintCompositorPrintFooter :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m ()
- data PrintCompositorPrintHeaderPropertyInfo
- constructPrintCompositorPrintHeader :: IsPrintCompositor o => Bool -> IO (GValueConstruct o)
- getPrintCompositorPrintHeader :: (MonadIO m, IsPrintCompositor o) => o -> m Bool
- printCompositorPrintHeader :: AttrLabelProxy "printHeader"
- setPrintCompositorPrintHeader :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m ()
- data PrintCompositorPrintLineNumbersPropertyInfo
- constructPrintCompositorPrintLineNumbers :: IsPrintCompositor o => Word32 -> IO (GValueConstruct o)
- getPrintCompositorPrintLineNumbers :: (MonadIO m, IsPrintCompositor o) => o -> m Word32
- printCompositorPrintLineNumbers :: AttrLabelProxy "printLineNumbers"
- setPrintCompositorPrintLineNumbers :: (MonadIO m, IsPrintCompositor o) => o -> Word32 -> m ()
- data PrintCompositorTabWidthPropertyInfo
- constructPrintCompositorTabWidth :: IsPrintCompositor o => Word32 -> IO (GValueConstruct o)
- getPrintCompositorTabWidth :: (MonadIO m, IsPrintCompositor o) => o -> m Word32
- printCompositorTabWidth :: AttrLabelProxy "tabWidth"
- setPrintCompositorTabWidth :: (MonadIO m, IsPrintCompositor o) => o -> Word32 -> m ()
- data PrintCompositorWrapModePropertyInfo
- constructPrintCompositorWrapMode :: IsPrintCompositor o => WrapMode -> IO (GValueConstruct o)
- getPrintCompositorWrapMode :: (MonadIO m, IsPrintCompositor o) => o -> m WrapMode
- printCompositorWrapMode :: AttrLabelProxy "wrapMode"
- setPrintCompositorWrapMode :: (MonadIO m, IsPrintCompositor o) => o -> WrapMode -> m ()
Exported types
newtype PrintCompositor Source #
Constructors
| PrintCompositor (ManagedPtr PrintCompositor) |
Instances
| GObject PrintCompositor Source # | |
| IsObject PrintCompositor Source # | |
| IsPrintCompositor PrintCompositor Source # | |
| ((~) * info (ResolvePrintCompositorMethod t PrintCompositor), MethodInfo * info PrintCompositor p) => IsLabel t (PrintCompositor -> p) Source # | |
| ((~) * info (ResolvePrintCompositorMethod t PrintCompositor), MethodInfo * info PrintCompositor p) => IsLabelProxy t (PrintCompositor -> p) Source # | |
| HasAttributeList * PrintCompositor Source # | |
| type AttributeList PrintCompositor Source # | |
| type SignalList PrintCompositor Source # | |
class GObject o => IsPrintCompositor o Source #
Instances
toPrintCompositor :: IsPrintCompositor o => o -> IO PrintCompositor Source #
Methods
drawPage
data PrintCompositorDrawPageMethodInfo Source #
Instances
| ((~) * signature (b -> Int32 -> m ()), MonadIO m, IsPrintCompositor a, IsPrintContext b) => MethodInfo * PrintCompositorDrawPageMethodInfo a signature Source # | |
printCompositorDrawPage Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a, IsPrintContext b) | |
| => a |
|
| -> b |
|
| -> Int32 |
|
| -> m () |
Draw page pageNr for printing on the the Cairo context encapsuled in context.
This method has been designed to be called in the handler of the PrintOperation::draw_page signal
as shown in the following example:
<informalexample><programlisting> // Signal handler for the GtkPrintOperation::draw_page signal
static void draw_page (GtkPrintOperation *operation, GtkPrintContext *context, gint page_nr, gpointer user_data) { GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
gtk_source_print_compositor_draw_page (compositor, context, page_nr); } </programlisting></informalexample>
getBodyFontName
data PrintCompositorGetBodyFontNameMethodInfo Source #
Instances
| ((~) * signature (m Text), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetBodyFontNameMethodInfo a signature Source # | |
printCompositorGetBodyFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Text | Returns: a new string containing the name of the font used to print the text body. |
Returns the name of the font used to print the text body. The returned string
must be freed with free.
Since: 2.2
getBottomMargin
data PrintCompositorGetBottomMarginMethodInfo Source #
Instances
| ((~) * signature (Unit -> m Double), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetBottomMarginMethodInfo a signature Source # | |
printCompositorGetBottomMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Unit |
|
| -> m Double | Returns: the bottom margin. |
Gets the bottom margin in units of unit.
Since: 2.2
getBuffer
data PrintCompositorGetBufferMethodInfo Source #
Instances
| ((~) * signature (m Buffer), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetBufferMethodInfo a signature Source # | |
printCompositorGetBuffer Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Buffer | Returns: the |
Gets the Buffer associated with the compositor. The returned
object reference is owned by the compositor object and
should not be unreferenced.
Since: 2.2
getFooterFontName
printCompositorGetFooterFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Text | Returns: a new string containing the name of the font used to print the page footer. |
Returns the name of the font used to print the page footer.
The returned string must be freed with free.
Since: 2.2
getHeaderFontName
data PrintCompositorGetHeaderFontNameMethodInfo Source #
Instances
| ((~) * signature (m Text), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetHeaderFontNameMethodInfo a signature Source # | |
printCompositorGetHeaderFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Text | Returns: a new string containing the name of the font used to print the page header. |
Returns the name of the font used to print the page header.
The returned string must be freed with free.
Since: 2.2
getHighlightSyntax
data PrintCompositorGetHighlightSyntaxMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetHighlightSyntaxMethodInfo a signature Source # | |
printCompositorGetHighlightSyntax Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Bool | Returns: |
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
data PrintCompositorGetLeftMarginMethodInfo Source #
Instances
| ((~) * signature (Unit -> m Double), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetLeftMarginMethodInfo a signature Source # | |
printCompositorGetLeftMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Unit |
|
| -> m Double | Returns: the left margin |
Gets the left margin in units of unit.
Since: 2.2
getLineNumbersFontName
data PrintCompositorGetLineNumbersFontNameMethodInfo Source #
Instances
| ((~) * signature (m Text), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetLineNumbersFontNameMethodInfo a signature Source # | |
printCompositorGetLineNumbersFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Text | Returns: a new string containing the name of the font used to print line numbers on the left margin. |
Returns the name of the font used to print line numbers on the left margin.
The returned string must be freed with free.
Since: 2.2
getNPages
data PrintCompositorGetNPagesMethodInfo Source #
Instances
| ((~) * signature (m Int32), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetNPagesMethodInfo a signature Source # | |
printCompositorGetNPages Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Int32 | Returns: the number of pages in the document or <code>-1</code> if the document has not been completely paginated. |
Returns the number of pages in the document or <code>-1</code> if the document has not been completely paginated.
Since: 2.2
getPaginationProgress
data PrintCompositorGetPaginationProgressMethodInfo Source #
Instances
| ((~) * signature (m Double), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetPaginationProgressMethodInfo a signature Source # | |
printCompositorGetPaginationProgress Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Double | Returns: a fraction from 0.0 to 1.0 inclusive. |
Returns the current fraction of the document pagination that has been completed.
Since: 2.2
getPrintFooter
printCompositorGetPrintFooter Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Bool | Returns: |
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 printCompositorSetFooterFormat.
Since: 2.2
getPrintHeader
data PrintCompositorGetPrintHeaderMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetPrintHeaderMethodInfo a signature Source # | |
printCompositorGetPrintHeader Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Bool | Returns: |
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 printCompositorSetHeaderFormat.
Since: 2.2
getPrintLineNumbers
data PrintCompositorGetPrintLineNumbersMethodInfo Source #
Instances
| ((~) * signature (m Word32), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetPrintLineNumbersMethodInfo a signature Source # | |
printCompositorGetPrintLineNumbers Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Word32 | Returns: the interval of printed line numbers. |
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
data PrintCompositorGetRightMarginMethodInfo Source #
Instances
| ((~) * signature (Unit -> m Double), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetRightMarginMethodInfo a signature Source # | |
printCompositorGetRightMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Unit |
|
| -> m Double | Returns: the right margin. |
Gets the right margin in units of unit.
Since: 2.2
getTabWidth
data PrintCompositorGetTabWidthMethodInfo Source #
Instances
| ((~) * signature (m Word32), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetTabWidthMethodInfo a signature Source # | |
printCompositorGetTabWidth Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m Word32 | Returns: width of tab. |
Returns the width of tabulation in characters for printed text.
Since: 2.2
getTopMargin
data PrintCompositorGetTopMarginMethodInfo Source #
Instances
| ((~) * signature (Unit -> m Double), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetTopMarginMethodInfo a signature Source # | |
printCompositorGetTopMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Unit |
|
| -> m Double | Returns: the top margin. |
Gets the top margin in units of unit.
Since: 2.2
getWrapMode
data PrintCompositorGetWrapModeMethodInfo Source #
Instances
| ((~) * signature (m WrapMode), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorGetWrapModeMethodInfo a signature Source # | |
printCompositorGetWrapMode Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> m WrapMode | Returns: the line wrap mode. |
Gets the line wrapping mode for the printed text.
Since: 2.2
new
Arguments
| :: (HasCallStack, MonadIO m, IsBuffer a) | |
| => a |
|
| -> m PrintCompositor | Returns: a new print compositor object. |
Creates a new print compositor that can be used to print buffer.
Since: 2.2
newFromView
printCompositorNewFromView Source #
Arguments
| :: (HasCallStack, MonadIO m, IsView a) | |
| => a |
|
| -> m PrintCompositor | Returns: a new print compositor object. |
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
PrintCompositor:tab-width, PrintCompositor:highlight-syntax,
PrintCompositor:wrap-mode, PrintCompositor:body-font-name and
PrintCompositor:print-line-numbers.
Since: 2.2
paginate
data PrintCompositorPaginateMethodInfo Source #
Instances
| ((~) * signature (b -> m Bool), MonadIO m, IsPrintCompositor a, IsPrintContext b) => MethodInfo * PrintCompositorPaginateMethodInfo a signature Source # | |
printCompositorPaginate Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a, IsPrintContext b) | |
| => a |
|
| -> b |
|
| -> m Bool | Returns: |
Paginate the document associated with the compositor.
In order to support non-blocking pagination, document is paginated in small chunks.
Each time printCompositorPaginate is invoked, a chunk of the document
is paginated. To paginate the entire document, printCompositorPaginate
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 PrintOperation::paginate signal,
as shown in the following example:
<informalexample><programlisting> // Signal handler for the GtkPrintOperation::paginate signal
static gboolean paginate (GtkPrintOperation *operation, GtkPrintContext *context, gpointer user_data) { GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
if (gtk_source_print_compositor_paginate (compositor, context)) { gint n_pages;
n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages);
return TRUE; }
return FALSE; } </programlisting></informalexample>
If you don't need to do pagination in chunks, you can simply do it all in the
PrintOperation::begin-print handler, and set the number of pages from there, like
in the following example:
<informalexample><programlisting> // Signal handler for the GtkPrintOperation::begin-print signal
static void begin_print (GtkPrintOperation *operation, GtkPrintContext *context, gpointer user_data) { GtkSourcePrintCompositor *compositor; gint n_pages;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
while (!gtk_source_print_compositor_paginate (compositor, context));
n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages); } </programlisting></informalexample>
Since: 2.2
setBodyFontName
data PrintCompositorSetBodyFontNameMethodInfo Source #
Instances
| ((~) * signature (Text -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetBodyFontNameMethodInfo a signature Source # | |
printCompositorSetBodyFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Text |
|
| -> m () |
Sets the default font for the printed text.
fontName should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See fontDescriptionFromString
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setBottomMargin
data PrintCompositorSetBottomMarginMethodInfo Source #
Instances
| ((~) * signature (Double -> Unit -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetBottomMarginMethodInfo a signature Source # | |
printCompositorSetBottomMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Double |
|
| -> Unit |
|
| -> m () |
Sets the bottom margin used by compositor.
Since: 2.2
setFooterFontName
printCompositorSetFooterFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the font for printing the page footer. If
Nothing is supplied, the default font (i.e. the one being used for the
text) will be used instead.
fontName should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See fontDescriptionFromString
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setFooterFormat
printCompositorSetFooterFormat Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Bool |
|
| -> Maybe Text |
|
| -> Maybe Text |
|
| -> Maybe Text |
|
| -> m () |
See printCompositorSetHeaderFormat for more information
about the parameters.
Since: 2.2
setHeaderFontName
data PrintCompositorSetHeaderFontNameMethodInfo Source #
Instances
| ((~) * signature (Maybe Text -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetHeaderFontNameMethodInfo a signature Source # | |
printCompositorSetHeaderFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the font for printing the page header. If
Nothing is supplied, the default font (i.e. the one being used for the
text) will be used instead.
fontName should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See fontDescriptionFromString
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setHeaderFormat
data PrintCompositorSetHeaderFormatMethodInfo Source #
Instances
| ((~) * signature (Bool -> Maybe Text -> Maybe Text -> Maybe Text -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetHeaderFormatMethodInfo a signature Source # | |
printCompositorSetHeaderFormat Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Bool |
|
| -> Maybe Text |
|
| -> Maybe Text |
|
| -> Maybe Text |
|
| -> m () |
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 dateTimeFormat
for more details on the accepted format specifiers.
Additionally the following format specifiers are accepted:
N: the page numberQ: the page count.
separator specifies if a solid line should be drawn to separate
the header from the document text.
If Nothing 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 printCompositorSetPrintHeader.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setHighlightSyntax
data PrintCompositorSetHighlightSyntaxMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetHighlightSyntaxMethodInfo a signature Source # | |
printCompositorSetHighlightSyntax Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Bool |
|
| -> m () |
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
printCompositorPaginate function.
Since: 2.2
setLeftMargin
data PrintCompositorSetLeftMarginMethodInfo Source #
Instances
| ((~) * signature (Double -> Unit -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetLeftMarginMethodInfo a signature Source # | |
printCompositorSetLeftMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Double |
|
| -> Unit |
|
| -> m () |
Sets the left margin used by compositor.
Since: 2.2
setLineNumbersFontName
data PrintCompositorSetLineNumbersFontNameMethodInfo Source #
Instances
| ((~) * signature (Maybe Text -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetLineNumbersFontNameMethodInfo a signature Source # | |
printCompositorSetLineNumbersFontName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the font for printing line numbers on the left margin. If
Nothing is supplied, the default font (i.e. the one being used for the
text) will be used instead.
fontName should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See fontDescriptionFromString
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setPrintFooter
printCompositorSetPrintFooter Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Bool |
|
| -> m () |
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
printCompositorSetFooterFormat.
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
printCompositorPaginate function.
Since: 2.2
setPrintHeader
data PrintCompositorSetPrintHeaderMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetPrintHeaderMethodInfo a signature Source # | |
printCompositorSetPrintHeader Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Bool |
|
| -> m () |
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
printCompositorSetHeaderFormat.
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
printCompositorPaginate function.
Since: 2.2
setPrintLineNumbers
data PrintCompositorSetPrintLineNumbersMethodInfo Source #
Instances
| ((~) * signature (Word32 -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetPrintLineNumbersMethodInfo a signature Source # | |
printCompositorSetPrintLineNumbers Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Word32 |
|
| -> m () |
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
printCompositorPaginate function.
Since: 2.2
setRightMargin
data PrintCompositorSetRightMarginMethodInfo Source #
Instances
| ((~) * signature (Double -> Unit -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetRightMarginMethodInfo a signature Source # | |
printCompositorSetRightMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Double |
|
| -> Unit |
|
| -> m () |
Sets the right margin used by compositor.
Since: 2.2
setTabWidth
data PrintCompositorSetTabWidthMethodInfo Source #
Instances
| ((~) * signature (Word32 -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetTabWidthMethodInfo a signature Source # | |
printCompositorSetTabWidth Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Word32 |
|
| -> m () |
Sets the width of tabulation in characters for printed text.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
setTopMargin
data PrintCompositorSetTopMarginMethodInfo Source #
Instances
| ((~) * signature (Double -> Unit -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetTopMarginMethodInfo a signature Source # | |
printCompositorSetTopMargin Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> Double |
|
| -> Unit |
|
| -> m () |
Sets the top margin used by compositor.
Since: 2.2
setWrapMode
data PrintCompositorSetWrapModeMethodInfo Source #
Instances
| ((~) * signature (WrapMode -> m ()), MonadIO m, IsPrintCompositor a) => MethodInfo * PrintCompositorSetWrapModeMethodInfo a signature Source # | |
printCompositorSetWrapMode Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintCompositor a) | |
| => a |
|
| -> WrapMode |
|
| -> m () |
Sets the line wrapping mode for the printed text.
This function cannot be called anymore after the first call to the
printCompositorPaginate function.
Since: 2.2
Properties
bodyFontName
data PrintCompositorBodyFontNamePropertyInfo Source #
Instances
constructPrintCompositorBodyFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o) Source #
getPrintCompositorBodyFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text) Source #
printCompositorBodyFontName :: AttrLabelProxy "bodyFontName" Source #
setPrintCompositorBodyFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m () Source #
buffer
data PrintCompositorBufferPropertyInfo Source #
Instances
constructPrintCompositorBuffer :: (IsPrintCompositor o, IsBuffer a) => a -> IO (GValueConstruct o) Source #
getPrintCompositorBuffer :: (MonadIO m, IsPrintCompositor o) => o -> m Buffer Source #
printCompositorBuffer :: AttrLabelProxy "buffer" Source #
footerFontName
clearPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> m () Source #
constructPrintCompositorFooterFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o) Source #
getPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text) Source #
printCompositorFooterFontName :: AttrLabelProxy "footerFontName" Source #
setPrintCompositorFooterFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m () Source #
headerFontName
data PrintCompositorHeaderFontNamePropertyInfo Source #
Instances
clearPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> m () Source #
constructPrintCompositorHeaderFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o) Source #
getPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text) Source #
printCompositorHeaderFontName :: AttrLabelProxy "headerFontName" Source #
setPrintCompositorHeaderFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m () Source #
highlightSyntax
data PrintCompositorHighlightSyntaxPropertyInfo Source #
Instances
constructPrintCompositorHighlightSyntax :: IsPrintCompositor o => Bool -> IO (GValueConstruct o) Source #
getPrintCompositorHighlightSyntax :: (MonadIO m, IsPrintCompositor o) => o -> m Bool Source #
printCompositorHighlightSyntax :: AttrLabelProxy "highlightSyntax" Source #
setPrintCompositorHighlightSyntax :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m () Source #
lineNumbersFontName
data PrintCompositorLineNumbersFontNamePropertyInfo Source #
Instances
clearPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> m () Source #
constructPrintCompositorLineNumbersFontName :: IsPrintCompositor o => Text -> IO (GValueConstruct o) Source #
getPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> m (Maybe Text) Source #
printCompositorLineNumbersFontName :: AttrLabelProxy "lineNumbersFontName" Source #
setPrintCompositorLineNumbersFontName :: (MonadIO m, IsPrintCompositor o) => o -> Text -> m () Source #
nPages
data PrintCompositorNPagesPropertyInfo Source #
Instances
getPrintCompositorNPages :: (MonadIO m, IsPrintCompositor o) => o -> m Int32 Source #
printCompositorNPages :: AttrLabelProxy "nPages" Source #
printFooter
constructPrintCompositorPrintFooter :: IsPrintCompositor o => Bool -> IO (GValueConstruct o) Source #
getPrintCompositorPrintFooter :: (MonadIO m, IsPrintCompositor o) => o -> m Bool Source #
printCompositorPrintFooter :: AttrLabelProxy "printFooter" Source #
setPrintCompositorPrintFooter :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m () Source #
printHeader
data PrintCompositorPrintHeaderPropertyInfo Source #
Instances
constructPrintCompositorPrintHeader :: IsPrintCompositor o => Bool -> IO (GValueConstruct o) Source #
getPrintCompositorPrintHeader :: (MonadIO m, IsPrintCompositor o) => o -> m Bool Source #
printCompositorPrintHeader :: AttrLabelProxy "printHeader" Source #
setPrintCompositorPrintHeader :: (MonadIO m, IsPrintCompositor o) => o -> Bool -> m () Source #
printLineNumbers
data PrintCompositorPrintLineNumbersPropertyInfo Source #
Instances
constructPrintCompositorPrintLineNumbers :: IsPrintCompositor o => Word32 -> IO (GValueConstruct o) Source #
getPrintCompositorPrintLineNumbers :: (MonadIO m, IsPrintCompositor o) => o -> m Word32 Source #
printCompositorPrintLineNumbers :: AttrLabelProxy "printLineNumbers" Source #
setPrintCompositorPrintLineNumbers :: (MonadIO m, IsPrintCompositor o) => o -> Word32 -> m () Source #
tabWidth
data PrintCompositorTabWidthPropertyInfo Source #
Instances
constructPrintCompositorTabWidth :: IsPrintCompositor o => Word32 -> IO (GValueConstruct o) Source #
getPrintCompositorTabWidth :: (MonadIO m, IsPrintCompositor o) => o -> m Word32 Source #
printCompositorTabWidth :: AttrLabelProxy "tabWidth" Source #
setPrintCompositorTabWidth :: (MonadIO m, IsPrintCompositor o) => o -> Word32 -> m () Source #
wrapMode
data PrintCompositorWrapModePropertyInfo Source #
Instances
constructPrintCompositorWrapMode :: IsPrintCompositor o => WrapMode -> IO (GValueConstruct o) Source #
getPrintCompositorWrapMode :: (MonadIO m, IsPrintCompositor o) => o -> m WrapMode Source #
printCompositorWrapMode :: AttrLabelProxy "wrapMode" Source #
setPrintCompositorWrapMode :: (MonadIO m, IsPrintCompositor o) => o -> WrapMode -> m () Source #