Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gtk.Objects.PrintUnixDialog

Contents

Exported types
Methods
Properties

Description

GtkPrintUnixDialog implements a print dialog for platforms which don’t provide a native print dialog, like Unix.

An example GtkPrintUnixDialog

It can be used very much like any other GTK dialog, at the cost of the portability offered by the high-level printing API with PrintOperation.

In order to print something with GtkPrintUnixDialog, you need to use printUnixDialogGetSelectedPrinter to obtain a Printer object and use it to construct a PrintJob using printJobNew.

GtkPrintUnixDialog uses the following response values:

ResponseTypeOk: for the “Print” button
ResponseTypeApply: for the “Preview” button
ResponseTypeCancel: for the “Cancel” button

GtkPrintUnixDialog as GtkBuildable

The GtkPrintUnixDialog implementation of the GtkBuildable interface exposes its notebook internal children with the name “notebook”.

An example of a GtkPrintUnixDialog UI definition fragment:

xml code

<object class="GtkPrintUnixDialog" id="dialog1">
  <child internal-child="notebook">
    <object class="GtkNotebook" id="notebook">
      <child>
        <object type="GtkNotebookPage">
          <property name="tab_expand">False</property>
          <property name="tab_fill">False</property>
          <property name="tab">
            <object class="GtkLabel" id="tablabel">
              <property name="label">Tab label</property>
            </object>
          </property>
          <property name="child">
            <object class="GtkLabel" id="tabcontent">
              <property name="label">Content on notebook tab</property>
            </object>
          </property>
        </object>
      </child>
    </object>
  </child>
</object>

CSS nodes

GtkPrintUnixDialog has a single CSS node with name window. The style classes dialog and print are added.

Synopsis

newtype PrintUnixDialog = PrintUnixDialog (ManagedPtr PrintUnixDialog)
class (GObject o, IsDescendantOf PrintUnixDialog o) => IsPrintUnixDialog o
toPrintUnixDialog :: (MonadIO m, IsPrintUnixDialog o) => o -> m PrintUnixDialog
printUnixDialogAddCustomTab :: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsWidget b, IsWidget c) => a -> b -> c -> m ()
printUnixDialogGetCurrentPage :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m Int32
printUnixDialogGetEmbedPageSetup :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m Bool
printUnixDialogGetHasSelection :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m Bool
printUnixDialogGetManualCapabilities :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m [PrintCapabilities]
printUnixDialogGetPageSetup :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m PageSetup
printUnixDialogGetPageSetupSet :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m Bool
printUnixDialogGetSelectedPrinter :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m (Maybe Printer)
printUnixDialogGetSettings :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m PrintSettings
printUnixDialogGetSupportSelection :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> m Bool
printUnixDialogNew :: (HasCallStack, MonadIO m, IsWindow a) => Maybe Text -> Maybe a -> m PrintUnixDialog
printUnixDialogSetCurrentPage :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> Int32 -> m ()
printUnixDialogSetEmbedPageSetup :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> Bool -> m ()
printUnixDialogSetHasSelection :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> Bool -> m ()
printUnixDialogSetManualCapabilities :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> [PrintCapabilities] -> m ()
printUnixDialogSetPageSetup :: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsPageSetup b) => a -> b -> m ()
printUnixDialogSetSettings :: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsPrintSettings b) => a -> Maybe b -> m ()
printUnixDialogSetSupportSelection :: (HasCallStack, MonadIO m, IsPrintUnixDialog a) => a -> Bool -> m ()
constructPrintUnixDialogCurrentPage :: (IsPrintUnixDialog o, MonadIO m) => Int32 -> m (GValueConstruct o)
getPrintUnixDialogCurrentPage :: (MonadIO m, IsPrintUnixDialog o) => o -> m Int32
setPrintUnixDialogCurrentPage :: (MonadIO m, IsPrintUnixDialog o) => o -> Int32 -> m ()
constructPrintUnixDialogEmbedPageSetup :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getPrintUnixDialogEmbedPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool
setPrintUnixDialogEmbedPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m ()
constructPrintUnixDialogHasSelection :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getPrintUnixDialogHasSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool
setPrintUnixDialogHasSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m ()
constructPrintUnixDialogManualCapabilities :: (IsPrintUnixDialog o, MonadIO m) => [PrintCapabilities] -> m (GValueConstruct o)
getPrintUnixDialogManualCapabilities :: (MonadIO m, IsPrintUnixDialog o) => o -> m [PrintCapabilities]
setPrintUnixDialogManualCapabilities :: (MonadIO m, IsPrintUnixDialog o) => o -> [PrintCapabilities] -> m ()
constructPrintUnixDialogPageSetup :: (IsPrintUnixDialog o, MonadIO m, IsPageSetup a) => a -> m (GValueConstruct o)
getPrintUnixDialogPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> m PageSetup
setPrintUnixDialogPageSetup :: (MonadIO m, IsPrintUnixDialog o, IsPageSetup a) => o -> a -> m ()
clearPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o) => o -> m ()
constructPrintUnixDialogPrintSettings :: (IsPrintUnixDialog o, MonadIO m, IsPrintSettings a) => a -> m (GValueConstruct o)
getPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o) => o -> m (Maybe PrintSettings)
setPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o, IsPrintSettings a) => o -> a -> m ()
getPrintUnixDialogSelectedPrinter :: (MonadIO m, IsPrintUnixDialog o) => o -> m (Maybe Printer)
constructPrintUnixDialogSupportSelection :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o)
getPrintUnixDialogSupportSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool
setPrintUnixDialogSupportSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m ()

Exported types

newtype PrintUnixDialog Source #

Memory-managed wrapper type.

Constructors

PrintUnixDialog (ManagedPtr PrintUnixDialog)

Instances

Instances details

Eq PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog Methods (==) :: PrintUnixDialog -> PrintUnixDialog -> Bool # (/=) :: PrintUnixDialog -> PrintUnixDialog -> Bool #
GObject PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog
ManagedPtrNewtype PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog Methods toManagedPtr :: PrintUnixDialog -> ManagedPtr PrintUnixDialog
TypedObject PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog Methods glibType :: IO GType
HasParentTypes PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog
IsGValue (Maybe PrintUnixDialog) Source #	Convert `PrintUnixDialog` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe PrintUnixDialog -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe PrintUnixDialog)
type ParentTypes PrintUnixDialog Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog type ParentTypes PrintUnixDialog = '[Dialog, Window, Widget, Object, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager]

class (GObject o, IsDescendantOf PrintUnixDialog o) => IsPrintUnixDialog o Source #

Type class for types which can be safely cast to PrintUnixDialog, for instance with toPrintUnixDialog.

Instances

Instances details

(GObject o, IsDescendantOf PrintUnixDialog o) => IsPrintUnixDialog o Source #
Instance details Defined in GI.Gtk.Objects.PrintUnixDialog

toPrintUnixDialog :: (MonadIO m, IsPrintUnixDialog o) => o -> m PrintUnixDialog Source #

Cast to PrintUnixDialog, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

getCurrentPage

printUnixDialogGetCurrentPage Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m Int32	Returns: the current page of `dialog`

Gets the current page of the GtkPrintUnixDialog.

getManualCapabilities

printUnixDialogGetManualCapabilities Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m [PrintCapabilities]	Returns: the printing capabilities

Gets the capabilities that have been set on this GtkPrintUnixDialog.

getPageSetup

printUnixDialogGetPageSetup Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m PageSetup	Returns: the page setup of `dialog`.

Gets the page setup that is used by the GtkPrintUnixDialog.

getPageSetupSet

printUnixDialogGetPageSetupSet Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m Bool	Returns: whether a page setup was set by user.

Gets whether a page setup was set by the user.

getSettings

printUnixDialogGetSettings Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m PrintSettings	Returns: a new `GtkPrintSettings` object with the values from `dialog`

Gets a new GtkPrintSettings object that represents the current values in the print dialog.

Note that this creates a new object, and you need to unref it if don’t want to keep it.

getSupportSelection

printUnixDialogGetSupportSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> m Bool	Returns: whether the application supports print of selection

Gets whether the print dialog allows user to print a selection.

setCurrentPage

printUnixDialogSetCurrentPage Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> Int32	`currentPage`: the current page number.
-> m ()

Sets the current page number.

If currentPage is not -1, this enables the current page choice for the range of pages to print.

setEmbedPageSetup

printUnixDialogSetEmbedPageSetup Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> Bool	`embed`: embed page setup selection
-> m ()

Embed page size combo box and orientation combo box into page setup page.

setManualCapabilities

printUnixDialogSetManualCapabilities Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> [PrintCapabilities]	`capabilities`: the printing capabilities of your application
-> m ()

This lets you specify the printing capabilities your application supports.

For instance, if you can handle scaling the output then you pass PrintCapabilitiesScale. If you don’t pass that, then the dialog will only let you select the scale if the printing system automatically handles scaling.

setPageSetup

printUnixDialogSetPageSetup Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsPageSetup b)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> b	`pageSetup`: a `GtkPageSetup`
-> m ()

Sets the page setup of the GtkPrintUnixDialog.

setSettings

printUnixDialogSetSettings Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsPrintSettings b)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> Maybe b	`settings`: a `GtkPrintSettings`
-> m ()

Sets the GtkPrintSettings for the GtkPrintUnixDialog.

Typically, this is used to restore saved print settings from a previous print operation before the print dialog is shown.

setSupportSelection

printUnixDialogSetSupportSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> Bool	`supportSelection`: `True` to allow print selection
-> m ()

Sets whether the print dialog allows user to print a selection.

Properties

currentPage

The current page in the document.

constructPrintUnixDialogCurrentPage :: (IsPrintUnixDialog o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “current-page” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogCurrentPage :: (MonadIO m, IsPrintUnixDialog o) => o -> m Int32 Source #

Get the value of the “current-page” property. When overloading is enabled, this is equivalent to

get printUnixDialog #currentPage

setPrintUnixDialogCurrentPage :: (MonadIO m, IsPrintUnixDialog o) => o -> Int32 -> m () Source #

Set the value of the “current-page” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #currentPage := value ]

embedPageSetup

True if the page setup controls are embedded.

constructPrintUnixDialogEmbedPageSetup :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “embed-page-setup” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogEmbedPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool Source #

Get the value of the “embed-page-setup” property. When overloading is enabled, this is equivalent to

get printUnixDialog #embedPageSetup

setPrintUnixDialogEmbedPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m () Source #

Set the value of the “embed-page-setup” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #embedPageSetup := value ]

hasSelection

Whether the application has a selection.

constructPrintUnixDialogHasSelection :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “has-selection” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogHasSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool Source #

Get the value of the “has-selection” property. When overloading is enabled, this is equivalent to

get printUnixDialog #hasSelection

setPrintUnixDialogHasSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m () Source #

Set the value of the “has-selection” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #hasSelection := value ]

manualCapabilities

Capabilities the application can handle.

constructPrintUnixDialogManualCapabilities :: (IsPrintUnixDialog o, MonadIO m) => [PrintCapabilities] -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “manual-capabilities” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogManualCapabilities :: (MonadIO m, IsPrintUnixDialog o) => o -> m [PrintCapabilities] Source #

Get the value of the “manual-capabilities” property. When overloading is enabled, this is equivalent to

get printUnixDialog #manualCapabilities

setPrintUnixDialogManualCapabilities :: (MonadIO m, IsPrintUnixDialog o) => o -> [PrintCapabilities] -> m () Source #

Set the value of the “manual-capabilities” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #manualCapabilities := value ]

pageSetup

The GtkPageSetup object to use.

constructPrintUnixDialogPageSetup :: (IsPrintUnixDialog o, MonadIO m, IsPageSetup a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “page-setup” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogPageSetup :: (MonadIO m, IsPrintUnixDialog o) => o -> m PageSetup Source #

Get the value of the “page-setup” property. When overloading is enabled, this is equivalent to

get printUnixDialog #pageSetup

setPrintUnixDialogPageSetup :: (MonadIO m, IsPrintUnixDialog o, IsPageSetup a) => o -> a -> m () Source #

Set the value of the “page-setup” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #pageSetup := value ]

printSettings

The GtkPrintSettings object used for this dialog.

clearPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o) => o -> m () Source #

Set the value of the “print-settings” property to Nothing. When overloading is enabled, this is equivalent to

clear #printSettings

constructPrintUnixDialogPrintSettings :: (IsPrintUnixDialog o, MonadIO m, IsPrintSettings a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “print-settings” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o) => o -> m (Maybe PrintSettings) Source #

Get the value of the “print-settings” property. When overloading is enabled, this is equivalent to

get printUnixDialog #printSettings

setPrintUnixDialogPrintSettings :: (MonadIO m, IsPrintUnixDialog o, IsPrintSettings a) => o -> a -> m () Source #

Set the value of the “print-settings” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #printSettings := value ]

selectedPrinter

The GtkPrinter which is selected.

getPrintUnixDialogSelectedPrinter :: (MonadIO m, IsPrintUnixDialog o) => o -> m (Maybe Printer) Source #

Get the value of the “selected-printer” property. When overloading is enabled, this is equivalent to

get printUnixDialog #selectedPrinter

supportSelection

Whether the dialog supports selection.

constructPrintUnixDialogSupportSelection :: (IsPrintUnixDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “support-selection” property. This is rarely needed directly, but it is used by new.

getPrintUnixDialogSupportSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> m Bool Source #

Get the value of the “support-selection” property. When overloading is enabled, this is equivalent to

get printUnixDialog #supportSelection

setPrintUnixDialogSupportSelection :: (MonadIO m, IsPrintUnixDialog o) => o -> Bool -> m () Source #

Set the value of the “support-selection” property. When overloading is enabled, this is equivalent to

set printUnixDialog [ #supportSelection := value ]

:: (HasCallStack, MonadIO m, IsWindow a)
=> Maybe Text	`title`: Title of the dialog
-> Maybe a	`parent`: Transient parent of the dialog
-> m PrintUnixDialog	Returns: a new `GtkPrintUnixDialog`

:: (HasCallStack, MonadIO m, IsPrintUnixDialog a, IsWidget b, IsWidget c)
=> a	`dialog`: a `GtkPrintUnixDialog`
-> b	`child`: the widget to put in the custom tab
-> c	`tabLabel`: the widget to use as tab label
-> m ()

GtkPrintUnixDialog as GtkBuildable

xml code

CSS nodes

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

addCustomTab

getCurrentPage

getEmbedPageSetup

getHasSelection

getManualCapabilities

getPageSetup

getPageSetupSet

getSelectedPrinter

getSettings

getSupportSelection

new

setCurrentPage

setEmbedPageSetup

setHasSelection

setManualCapabilities

setPageSetup

setSettings

setSupportSelection

Properties

currentPage

embedPageSetup

hasSelection

manualCapabilities

pageSetup

printSettings

selectedPrinter

supportSelection