<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkPrinter">
<refmeta>
<refentrytitle role="top_of_page" id="GtkPrinter.top_of_page">GtkPrinter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkPrinter</refname>
<refpurpose>Represents a printer</refpurpose>
</refnamediv>

<refsect1 id="GtkPrinter.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkPrinter"><returnvalue>GtkPrinter</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-new">gtk_printer_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPrintBackend"><returnvalue>GtkPrintBackend</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-backend">gtk_printer_get_backend</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-name">gtk_printer_get_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-state-message">gtk_printer_get_state_message</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-description">gtk_printer_get_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-location">gtk_printer_get_location</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-icon-name">gtk_printer_get_icon_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-get-job-count">gtk_printer_get_job_count</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-is-active">gtk_printer_is_active</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-is-paused">gtk_printer_is_paused</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-is-accepting-jobs">gtk_printer_is_accepting_jobs</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-is-virtual">gtk_printer_is_virtual</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-is-default">gtk_printer_is_default</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-accepts-ps">gtk_printer_accepts_ps</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-accepts-pdf">gtk_printer_accepts_pdf</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-list-papers">gtk_printer_list_papers</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-compare">gtk_printer_compare</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-has-details">gtk_printer_has_details</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-request-details">gtk_printer_request_details</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPrintCapabilities"><returnvalue>GtkPrintCapabilities</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-get-capabilities">gtk_printer_get_capabilities</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPageSetup"><returnvalue>GtkPageSetup</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-printer-get-default-page-size">gtk_printer_get_default_page_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-get-hard-margins">gtk_printer_get_hard_margins</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-printer-get-hard-margins-for-paper-size">gtk_printer_get_hard_margins_for_paper_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><phrase role="c_punctuation">(</phrase><link linkend="GtkPrinterFunc">*GtkPrinterFunc</link><phrase role="c_punctuation">)</phrase>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-enumerate-printers">gtk_enumerate_printers</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkPrinter.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--accepting-jobs">accepting-jobs</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--accepts-pdf">accepts-pdf</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--accepts-ps">accepts-ps</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="GtkPrintBackend"><type>GtkPrintBackend</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkPrinter--backend">backend</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkPrinter--icon-name">icon-name</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--is-virtual">is-virtual</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--job-count">job-count</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkPrinter--location">location</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkPrinter--name">name</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkPrinter--paused">paused</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkPrinter--state-message">state-message</link></entry><entry role="property_flags">Read</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkPrinter.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signal_proto_type" colwidth="150px"/>
<colspec colname="signal_proto_name" colwidth="300px"/>
<colspec colname="signal_proto_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GtkPrinter-details-acquired">details-acquired</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<anchor id="GtkPrintBackend"/><refsect1 id="GtkPrinter.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkPrinter-struct">GtkPrinter</link></entry></row>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkPrintBackend-struct">GtkPrintBackend</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkPrinter.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9500;&#9472;&#9472;</phrase> GtkPrintBackend
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkPrinter
</screen>
</refsect1>

<refsect1 id="GtkPrinter.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkPrinter.description" role="desc">
<title role="desc.title">Description</title>
<para>A <link linkend="GtkPrinter"><type>GtkPrinter</type></link> object represents a printer. You only need to
deal directly with printers if you use the non-portable
<link linkend="GtkPrintUnixDialog"><type>GtkPrintUnixDialog</type></link> API.</para>
<para>A <link linkend="GtkPrinter"><type>GtkPrinter</type></link> allows to get status information about the printer,
such as its description, its location, the number of queued jobs,
etc. Most importantly, a <link linkend="GtkPrinter"><type>GtkPrinter</type></link> object can be used to create
a <link linkend="GtkPrintJob"><type>GtkPrintJob</type></link> object, which lets you print to the printer.</para>
<para>Printing support was added in GTK+ 2.10.</para>

</refsect1>
<refsect1 id="GtkPrinter.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-printer-new" role="function">
<title>gtk_printer_new&#160;()</title>
<indexterm zone="gtk-printer-new"><primary>gtk_printer_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkPrinter"><returnvalue>GtkPrinter</returnvalue></link>&#160;*
gtk_printer_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
                 <parameter><link linkend="GtkPrintBackend"><type>GtkPrintBackend</type></link> *backend</parameter>,
                 <parameter><link linkend="gboolean"><type>gboolean</type></link> virtual_</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkPrinter"><type>GtkPrinter</type></link>.</para>
<refsect3 id="gtk-printer-new.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>name</para></entry>
<entry role="parameter_description"><para>the name of the printer</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>backend</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrintBackend"><type>GtkPrintBackend</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>virtual_</para></entry>
<entry role="parameter_description"><para>whether the printer is virtual</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-backend" role="function">
<title>gtk_printer_get_backend&#160;()</title>
<indexterm zone="gtk-printer-get-backend"><primary>gtk_printer_get_backend</primary></indexterm>
<programlisting language="C"><link linkend="GtkPrintBackend"><returnvalue>GtkPrintBackend</returnvalue></link>&#160;*
gtk_printer_get_backend (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns the backend of the printer.</para>
<refsect3 id="gtk-printer-get-backend.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-backend.returns" role="returns">
<title>Returns</title>
<para>the backend of <parameter>printer</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-name" role="function">
<title>gtk_printer_get_name&#160;()</title>
<indexterm zone="gtk-printer-get-name"><primary>gtk_printer_get_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_printer_get_name (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns the name of the printer.</para>
<refsect3 id="gtk-printer-get-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-name.returns" role="returns">
<title>Returns</title>
<para> the name of <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-state-message" role="function">
<title>gtk_printer_get_state_message&#160;()</title>
<indexterm zone="gtk-printer-get-state-message"><primary>gtk_printer_get_state_message</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_printer_get_state_message (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns the state message describing the current state
of the printer.</para>
<refsect3 id="gtk-printer-get-state-message.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-state-message.returns" role="returns">
<title>Returns</title>
<para> the state message of <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-description" role="function">
<title>gtk_printer_get_description&#160;()</title>
<indexterm zone="gtk-printer-get-description"><primary>gtk_printer_get_description</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_printer_get_description (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Gets the description of the printer.</para>
<refsect3 id="gtk-printer-get-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-description.returns" role="returns">
<title>Returns</title>
<para> the description of <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-location" role="function">
<title>gtk_printer_get_location&#160;()</title>
<indexterm zone="gtk-printer-get-location"><primary>gtk_printer_get_location</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_printer_get_location (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns a description of the location of the printer.</para>
<refsect3 id="gtk-printer-get-location.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-location.returns" role="returns">
<title>Returns</title>
<para> the location of <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-icon-name" role="function">
<title>gtk_printer_get_icon_name&#160;()</title>
<indexterm zone="gtk-printer-get-icon-name"><primary>gtk_printer_get_icon_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_printer_get_icon_name (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Gets the name of the icon to use for the printer.</para>
<refsect3 id="gtk-printer-get-icon-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-icon-name.returns" role="returns">
<title>Returns</title>
<para> the icon name for <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-job-count" role="function">
<title>gtk_printer_get_job_count&#160;()</title>
<indexterm zone="gtk-printer-get-job-count"><primary>gtk_printer_get_job_count</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_printer_get_job_count (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Gets the number of jobs currently queued on the printer.</para>
<refsect3 id="gtk-printer-get-job-count.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-job-count.returns" role="returns">
<title>Returns</title>
<para> the number of jobs on <parameter>printer</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-is-active" role="function">
<title>gtk_printer_is_active&#160;()</title>
<indexterm zone="gtk-printer-is-active"><primary>gtk_printer_is_active</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_is_active (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer is currently active (i.e. 
accepts new jobs).</para>
<refsect3 id="gtk-printer-is-active.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-is-active.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
is active</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-is-paused" role="function">
<title>gtk_printer_is_paused&#160;()</title>
<indexterm zone="gtk-printer-is-paused"><primary>gtk_printer_is_paused</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_is_paused (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer is currently paused.
A paused printer still accepts jobs, but it is not
printing them.</para>
<refsect3 id="gtk-printer-is-paused.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-is-paused.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
is paused</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-is-accepting-jobs" role="function">
<title>gtk_printer_is_accepting_jobs&#160;()</title>
<indexterm zone="gtk-printer-is-accepting-jobs"><primary>gtk_printer_is_accepting_jobs</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_is_accepting_jobs (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer is accepting jobs</para>
<refsect3 id="gtk-printer-is-accepting-jobs.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-is-accepting-jobs.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
is accepting jobs</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-is-virtual" role="function">
<title>gtk_printer_is_virtual&#160;()</title>
<indexterm zone="gtk-printer-is-virtual"><primary>gtk_printer_is_virtual</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_is_virtual (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer is virtual (i.e. does not
represent actual printer hardware, but something like 
a CUPS class).</para>
<refsect3 id="gtk-printer-is-virtual.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-is-virtual.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
is virtual</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-is-default" role="function">
<title>gtk_printer_is_default&#160;()</title>
<indexterm zone="gtk-printer-is-default"><primary>gtk_printer_is_default</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_is_default (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer is the default printer.</para>
<refsect3 id="gtk-printer-is-default.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-is-default.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
is the default</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-accepts-ps" role="function">
<title>gtk_printer_accepts_ps&#160;()</title>
<indexterm zone="gtk-printer-accepts-ps"><primary>gtk_printer_accepts_ps</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_accepts_ps (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer accepts input in
PostScript format.</para>
<refsect3 id="gtk-printer-accepts-ps.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-accepts-ps.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
accepts PostScript</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-accepts-pdf" role="function">
<title>gtk_printer_accepts_pdf&#160;()</title>
<indexterm zone="gtk-printer-accepts-pdf"><primary>gtk_printer_accepts_pdf</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_accepts_pdf (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer accepts input in
PDF format.</para>
<refsect3 id="gtk-printer-accepts-pdf.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-accepts-pdf.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
accepts PDF</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-list-papers" role="function">
<title>gtk_printer_list_papers&#160;()</title>
<indexterm zone="gtk-printer-list-papers"><primary>gtk_printer_list_papers</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
gtk_printer_list_papers (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Lists all the paper sizes <parameter>printer</parameter>
 supports.
This will return and empty list unless the printer’s details are 
available, see <link linkend="gtk-printer-has-details"><function>gtk_printer_has_details()</function></link> and <link linkend="gtk-printer-request-details"><function>gtk_printer_request_details()</function></link>.</para>
<refsect3 id="gtk-printer-list-papers.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-list-papers.returns" role="returns">
<title>Returns</title>
<para>a newly allocated list of newly allocated <link linkend="GtkPageSetup"><type>GtkPageSetup</type></link> s. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> GtkPageSetup][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-compare" role="function">
<title>gtk_printer_compare&#160;()</title>
<indexterm zone="gtk-printer-compare"><primary>gtk_printer_compare</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_printer_compare (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *a</parameter>,
                     <parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *b</parameter>);</programlisting>
<para>Compares two printers.</para>
<refsect3 id="gtk-printer-compare.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>a</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>b</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-compare.returns" role="returns">
<title>Returns</title>
<para> 0 if the printer match, a negative value if <parameter>a</parameter>
&lt; <parameter>b</parameter>
,
or a positive value if <parameter>a</parameter>
&gt; <parameter>b</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-has-details" role="function">
<title>gtk_printer_has_details&#160;()</title>
<indexterm zone="gtk-printer-has-details"><primary>gtk_printer_has_details</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_has_details (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns whether the printer details are available.</para>
<refsect3 id="gtk-printer-has-details.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-has-details.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>printer</parameter>
details are available</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-request-details" role="function">
<title>gtk_printer_request_details&#160;()</title>
<indexterm zone="gtk-printer-request-details"><primary>gtk_printer_request_details</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_printer_request_details (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Requests the printer details. When the details are available,
the <link linkend="GtkPrinter-details-acquired"><type>“details-acquired”</type></link> signal will be emitted on <parameter>printer</parameter>
.</para>
<refsect3 id="gtk-printer-request-details.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-capabilities" role="function">
<title>gtk_printer_get_capabilities&#160;()</title>
<indexterm zone="gtk-printer-get-capabilities"><primary>gtk_printer_get_capabilities</primary></indexterm>
<programlisting language="C"><link linkend="GtkPrintCapabilities"><returnvalue>GtkPrintCapabilities</returnvalue></link>
gtk_printer_get_capabilities (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns the printer’s capabilities.</para>
<para>This is useful when you’re using <link linkend="GtkPrintUnixDialog"><type>GtkPrintUnixDialog</type></link>’s manual-capabilities 
setting and need to know which settings the printer can handle and which 
you must handle yourself.</para>
<para>This will return 0 unless the printer’s details are available, see
<link linkend="gtk-printer-has-details"><function>gtk_printer_has_details()</function></link> and <link linkend="gtk-printer-request-details"><function>gtk_printer_request_details()</function></link>.</para>
<refsect3 id="gtk-printer-get-capabilities.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-capabilities.returns" role="returns">
<title>Returns</title>
<para> the printer’s capabilities</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-default-page-size" role="function">
<title>gtk_printer_get_default_page_size&#160;()</title>
<indexterm zone="gtk-printer-get-default-page-size"><primary>gtk_printer_get_default_page_size</primary></indexterm>
<programlisting language="C"><link linkend="GtkPageSetup"><returnvalue>GtkPageSetup</returnvalue></link>&#160;*
gtk_printer_get_default_page_size (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>);</programlisting>
<para>Returns default page size of <parameter>printer</parameter>
.</para>
<refsect3 id="gtk-printer-get-default-page-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-default-page-size.returns" role="returns">
<title>Returns</title>
<para> a newly allocated <link linkend="GtkPageSetup"><type>GtkPageSetup</type></link> with default page size of the printer.</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-hard-margins" role="function">
<title>gtk_printer_get_hard_margins&#160;()</title>
<indexterm zone="gtk-printer-get-hard-margins"><primary>gtk_printer_get_hard_margins</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_get_hard_margins (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>,
                              <parameter><link linkend="gdouble"><type>gdouble</type></link> *top</parameter>,
                              <parameter><link linkend="gdouble"><type>gdouble</type></link> *bottom</parameter>,
                              <parameter><link linkend="gdouble"><type>gdouble</type></link> *left</parameter>,
                              <parameter><link linkend="gdouble"><type>gdouble</type></link> *right</parameter>);</programlisting>
<para>Retrieve the hard margins of <parameter>printer</parameter>
, i.e. the margins that define
the area at the borders of the paper that the printer cannot print to.</para>
<para>Note: This will not succeed unless the printer’s details are available,
see <link linkend="gtk-printer-has-details"><function>gtk_printer_has_details()</function></link> and <link linkend="gtk-printer-request-details"><function>gtk_printer_request_details()</function></link>.</para>
<refsect3 id="gtk-printer-get-hard-margins.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>top</para></entry>
<entry role="parameter_description"><para>a location to store the top margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>bottom</para></entry>
<entry role="parameter_description"><para>a location to store the bottom margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>left</para></entry>
<entry role="parameter_description"><para>a location to store the left margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>right</para></entry>
<entry role="parameter_description"><para>a location to store the right margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-hard-margins.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> iff the hard margins were retrieved</para>
</refsect3></refsect2>
<refsect2 id="gtk-printer-get-hard-margins-for-paper-size" role="function">
<title>gtk_printer_get_hard_margins_for_paper_size&#160;()</title>
<indexterm zone="gtk-printer-get-hard-margins-for-paper-size"><primary>gtk_printer_get_hard_margins_for_paper_size</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_printer_get_hard_margins_for_paper_size
                               (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>,
                                <parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *paper_size</parameter>,
                                <parameter><link linkend="gdouble"><type>gdouble</type></link> *top</parameter>,
                                <parameter><link linkend="gdouble"><type>gdouble</type></link> *bottom</parameter>,
                                <parameter><link linkend="gdouble"><type>gdouble</type></link> *left</parameter>,
                                <parameter><link linkend="gdouble"><type>gdouble</type></link> *right</parameter>);</programlisting>
<para>Retrieve the hard margins of <parameter>printer</parameter>
 for <parameter>paper_size</parameter>
, i.e. the
margins that define the area at the borders of the paper that the
printer cannot print to.</para>
<para>Note: This will not succeed unless the printer's details are available,
see <link linkend="gtk-printer-has-details"><function>gtk_printer_has_details()</function></link> and <link linkend="gtk-printer-request-details"><function>gtk_printer_request_details()</function></link>.</para>
<refsect3 id="gtk-printer-get-hard-margins-for-paper-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>paper_size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>top</para></entry>
<entry role="parameter_description"><para>a location to store the top margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>bottom</para></entry>
<entry role="parameter_description"><para>a location to store the bottom margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>left</para></entry>
<entry role="parameter_description"><para>a location to store the left margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>right</para></entry>
<entry role="parameter_description"><para>a location to store the right margin in. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-printer-get-hard-margins-for-paper-size.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> iff the hard margins were retrieved</para>
</refsect3></refsect2>
<refsect2 id="GtkPrinterFunc" role="function">
<title>GtkPrinterFunc&#160;()</title>
<indexterm zone="GtkPrinterFunc"><primary>GtkPrinterFunc</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
<phrase role="c_punctuation">(</phrase>*GtkPrinterFunc<phrase role="c_punctuation">)</phrase> (<parameter><link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer</parameter>,
                   <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
<para>The type of function passed to <link linkend="gtk-enumerate-printers"><function>gtk_enumerate_printers()</function></link>.
Note that you need to ref <parameter>printer</parameter>
, if you want to keep
a reference to it after the function has returned.</para>
<refsect3 id="GtkPrinterFunc.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPrinter"><type>GtkPrinter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>data</para></entry>
<entry role="parameter_description"><para>user data passed to <link linkend="gtk-enumerate-printers"><function>gtk_enumerate_printers()</function></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="GtkPrinterFunc.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to stop the enumeration, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to continue</para>
</refsect3></refsect2>
<refsect2 id="gtk-enumerate-printers" role="function">
<title>gtk_enumerate_printers&#160;()</title>
<indexterm zone="gtk-enumerate-printers"><primary>gtk_enumerate_printers</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_enumerate_printers (<parameter><link linkend="GtkPrinterFunc"><type>GtkPrinterFunc</type></link> func</parameter>,
                        <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
                        <parameter><link linkend="GDestroyNotify"><type>GDestroyNotify</type></link> destroy</parameter>,
                        <parameter><link linkend="gboolean"><type>gboolean</type></link> wait</parameter>);</programlisting>
<para>Calls a function for all <link linkend="GtkPrinters"><type>GtkPrinters</type></link>. 
If <parameter>func</parameter>
 returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the enumeration is stopped.</para>
<refsect3 id="gtk-enumerate-printers.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>func</para></entry>
<entry role="parameter_description"><para>a function to call for each printer</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>data</para></entry>
<entry role="parameter_description"><para>user data to pass to <parameter>func</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>destroy</para></entry>
<entry role="parameter_description"><para>function to call if <parameter>data</parameter>
is no longer needed</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>wait</para></entry>
<entry role="parameter_description"><para>if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, wait in a recursive mainloop until
all printers are enumerated; otherwise return early</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkPrinter.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkPrinter-struct" role="struct">
<title>GtkPrinter</title>
<indexterm zone="GtkPrinter-struct"><primary>GtkPrinter</primary></indexterm>
<programlisting language="C">typedef struct _GtkPrinter GtkPrinter;</programlisting>
</refsect2>
<refsect2 id="GtkPrintBackend-struct" role="struct">
<title>GtkPrintBackend</title>
<indexterm zone="GtkPrintBackend-struct"><primary>GtkPrintBackend</primary></indexterm>
<programlisting language="C">typedef struct _GtkPrintBackend GtkPrintBackend;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkPrinter.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkPrinter--accepting-jobs" role="property"><title>The <literal>“accepting-jobs”</literal> property</title>
<indexterm zone="GtkPrinter--accepting-jobs"><primary>GtkPrinter:accepting-jobs</primary></indexterm>
<programlisting>  “accepting-jobs”           <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>This property is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the printer is accepting jobs.</para>
<para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkPrinter--accepts-pdf" role="property"><title>The <literal>“accepts-pdf”</literal> property</title>
<indexterm zone="GtkPrinter--accepts-pdf"><primary>GtkPrinter:accepts-pdf</primary></indexterm>
<programlisting>  “accepts-pdf”              <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>TRUE if this printer can accept PDF.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkPrinter--accepts-ps" role="property"><title>The <literal>“accepts-ps”</literal> property</title>
<indexterm zone="GtkPrinter--accepts-ps"><primary>GtkPrinter:accepts-ps</primary></indexterm>
<programlisting>  “accepts-ps”               <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>TRUE if this printer can accept PostScript.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkPrinter--backend" role="property"><title>The <literal>“backend”</literal> property</title>
<indexterm zone="GtkPrinter--backend"><primary>GtkPrinter:backend</primary></indexterm>
<programlisting>  “backend”                  <link linkend="GtkPrintBackend"><type>GtkPrintBackend</type></link>&#160;*</programlisting>
<para>Backend for the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
</refsect2>
<refsect2 id="GtkPrinter--icon-name" role="property"><title>The <literal>“icon-name”</literal> property</title>
<indexterm zone="GtkPrinter--icon-name"><primary>GtkPrinter:icon-name</primary></indexterm>
<programlisting>  “icon-name”                <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The icon name to use for the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkPrinter--is-virtual" role="property"><title>The <literal>“is-virtual”</literal> property</title>
<indexterm zone="GtkPrinter--is-virtual"><primary>GtkPrinter:is-virtual</primary></indexterm>
<programlisting>  “is-virtual”               <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>FALSE if this represents a real hardware printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkPrinter--job-count" role="property"><title>The <literal>“job-count”</literal> property</title>
<indexterm zone="GtkPrinter--job-count"><primary>GtkPrinter:job-count</primary></indexterm>
<programlisting>  “job-count”                <link linkend="gint"><type>gint</type></link></programlisting>
<para>Number of jobs queued in the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkPrinter--location" role="property"><title>The <literal>“location”</literal> property</title>
<indexterm zone="GtkPrinter--location"><primary>GtkPrinter:location</primary></indexterm>
<programlisting>  “location”                 <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The location of the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkPrinter--name" role="property"><title>The <literal>“name”</literal> property</title>
<indexterm zone="GtkPrinter--name"><primary>GtkPrinter:name</primary></indexterm>
<programlisting>  “name”                     <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>Name of the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkPrinter--paused" role="property"><title>The <literal>“paused”</literal> property</title>
<indexterm zone="GtkPrinter--paused"><primary>GtkPrinter:paused</primary></indexterm>
<programlisting>  “paused”                   <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>This property is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if this printer is paused.

A paused printer still accepts jobs, but it does

not print them.</para>
<para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkPrinter--state-message" role="property"><title>The <literal>“state-message”</literal> property</title>
<indexterm zone="GtkPrinter--state-message"><primary>GtkPrinter:state-message</primary></indexterm>
<programlisting>  “state-message”            <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>String giving the current state of the printer.</para><para>Owner: GtkPrinter</para>
<para>Flags: Read</para>
<para>Default value: ""</para>
</refsect2>

</refsect1>
<refsect1 id="GtkPrinter.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkPrinter-details-acquired" role="signal"><title>The <literal>“details-acquired”</literal> signal</title>
<indexterm zone="GtkPrinter-details-acquired"><primary>GtkPrinter::details-acquired</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkPrinter"><type>GtkPrinter</type></link> *printer,
               <link linkend="gboolean"><type>gboolean</type></link>    success,
               <link linkend="gpointer"><type>gpointer</type></link>    user_data)</programlisting>
<para>Gets emitted in response to a request for detailed information
about a printer from the print backend. The <parameter>success</parameter>
 parameter
indicates if the information was actually obtained.</para>
<refsect3 id="GtkPrinter-details-acquired.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>printer</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkPrinter"><type>GtkPrinter</type></link> on which the signal is emitted</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>success</para></entry>
<entry role="parameter_description"><para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the details were successfully acquired</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>

</refentry>
