Commit 19448b97 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkPrinter

parent b00a09de
......@@ -6,6 +6,7 @@ gtkmessagedialog.sgml
gtkobject.sgml
gtkorientable.sgml
gtkpagesetupunixdialog.sgml
gtkprinter.sgml
gtkradioaction.sgml
gtkrecentaction.sgml
gtkrecentchooserwidget.sgml
......
<!-- ##### SECTION Title ##### -->
GtkPrinter
<!-- ##### SECTION Short_Description ##### -->
Represents a printer
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkPrinter object represents a printer. You only need to
deal directly with printers if you use the non-portable
#GtkPrintUnixDialog API.
</para>
<para>
A #GtkPrinter allows to get status information about the printer,
such as its description, its location, the number of queued jobs,
etc. Most importantly, a #GtkPrinter object can be used to create
a #GtkPrintJob object, which lets you print to the printer.
</para>
<para>
Printing support was added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkPrinter ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkPrinter::details-acquired ##### -->
<para>
</para>
@printer: the object which received the signal.
@arg1:
<!-- ##### ARG GtkPrinter:accepting-jobs ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:accepts-pdf ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:accepts-ps ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:backend ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:icon-name ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:is-virtual ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:job-count ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:location ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:name ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:paused ##### -->
<para>
</para>
<!-- ##### ARG GtkPrinter:state-message ##### -->
<para>
</para>
<!-- ##### STRUCT GtkPrintBackend ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_printer_new ##### -->
<para>
</para>
@name:
@backend:
@virtual_:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_backend ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_name ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_state_message ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_description ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_location ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_icon_name ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_job_count ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_is_active ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_is_paused ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_is_accepting_jobs ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_is_virtual ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_is_default ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_accepts_ps ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_accepts_pdf ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_list_papers ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_compare ##### -->
<para>
</para>
@a:
@b:
@Returns:
<!-- ##### FUNCTION gtk_printer_has_details ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_request_details ##### -->
<para>
</para>
@printer:
<!-- ##### FUNCTION gtk_printer_get_capabilities ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_default_page_size ##### -->
<para>
</para>
@printer:
@Returns:
<!-- ##### FUNCTION gtk_printer_get_hard_margins ##### -->
<para>
</para>
@printer:
@top:
@bottom:
@left:
@right:
@Returns:
<!-- ##### USER_FUNCTION GtkPrinterFunc ##### -->
<para>
The type of function passed to gtk_enumerate_printers().
Note that you need to ref @printer, if you want to keep
a reference to it after the function has returned.
</para>
@printer: a #GtkPrinter
@data: user data passed to gtk_enumerate_printers()
@Returns: %TRUE to stop the enumeration, %FALSE to continue
<!-- ##### FUNCTION gtk_enumerate_printers ##### -->
<para>
</para>
@func:
@data:
@destroy:
@wait:
......@@ -31,6 +31,25 @@
#include "gtkprintjob.h"
#include "gtkalias.h"
/**
* SECTION:gtkprinter
* @Short_description: Represents a printer
* @Title: GtkPrinter
*
* A #GtkPrinter object represents a printer. You only need to
* deal directly with printers if you use the non-portable
* #GtkPrintUnixDialog API.
*
* A #GtkPrinter allows to get status information about the printer,
* such as its description, its location, the number of queued jobs,
* etc. Most importantly, a #GtkPrinter object can be used to create
* a #GtkPrintJob object, which lets you print to the printer.
*
* Printing support was added in GTK+ 2.10.
*/
#define GTK_PRINTER_GET_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINTER, GtkPrinterPrivate))
......
......@@ -119,6 +119,19 @@ gboolean gtk_printer_get_hard_margins (GtkPrinter *pr
gdouble *left,
gdouble *right);
/**
* GtkPrinterFunc:
* @printer: a #GtkPrinter
* @data: user data passed to gtk_enumerate_printers()
*
* The type of function passed to gtk_enumerate_printers().
* Note that you need to ref @printer, if you want to keep
* a reference to it after the function has returned.
*
* Returns: %TRUE to stop the enumeration, %FALSE to continue
*
* Since: 2.10
*/
typedef gboolean (*GtkPrinterFunc) (GtkPrinter *printer,
gpointer data);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment