Lerking/gtk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more docs

Browse Source
This commit is contained in:
Matthias Clasen
2006-04-14 02:47:16 +00:00
parent e2a4094aa6
commit f17a09ba8d
6 changed files with 135 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/gtk/gtk-docs.sgml
View File

@@ -521,9 +521,9 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
&GtkPrintSettings;
&GtkPageSetup;
&GtkPaperSize;
&GtkPrintUnixDialog;
&GtkPrinter;
&GtkPrintJob;
&GtkPrintUnixDialog;
&GtkPageSetupUnixDialog;
</chapter>

5
docs/reference/gtk/gtk-sections.txt
View File

@@ -5834,6 +5834,7 @@ GtkPrintOperationPrivate
<SECTION>
<INCLUDE>gtk/gtkprintunixdialog.h</INCLUDE>
<FILE>gtkprintunixdialog</FILE>
<TITLE>GtkPrintUnixDialog</TITLE>
GtkPrintUnixDialog
@@ -5861,15 +5862,18 @@ gtk_print_unix_dialog_get_type
<FILE>gtkprinter</FILE>
<TITLE>GtkPrinter</TITLE>
GtkPrinter
GtkPrintBackend
gtk_printer_new
gtk_printer_get_backend
gtk_printer_get_name
gtk_printer_get_state_message
gtk_printer_get_description
gtk_printer_get_location
gtk_printer_get_icon_name
gtk_printer_get_job_count
gtk_printer_is_active
gtk_printer_is_virtual
gtk_printer_is_default
<SUBSECTION Standard>
GTK_TYPE_PRINTER
@@ -6095,6 +6099,7 @@ gtk_print_job_get_type
<SECTION>
<INCLUDE>gtk/gtkpagesetupunixdialog.h</INCLUDE>
<FILE>gtkpagesetupunixdialog</FILE>
<TITLE>GtkPageSetupUnixDialog</TITLE>
GtkPageSetupUnixDialog

11
docs/reference/gtk/tmpl/gtkpagesetupunixdialog.sgml
View File

@@ -2,13 +2,20 @@
GtkPageSetupUnixDialog
<!-- ##### SECTION Short_Description ##### -->
A page setup dialog
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkPageSetupUnixDialog implements a page setup dialog for platforms
which don't provide a native page setup dialog, like Unix. It can
be used very much like any other GTK+ dialog, at the cost of
the portability offered by the <link
linkend="gtk-High-level-Printing-API">high-level printing API</link>
</para>
<para>
Printing support was added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>

64
docs/reference/gtk/tmpl/gtkprinter.sgml
View File

@@ -2,20 +2,30 @@
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 ##### -->
@@ -24,14 +34,58 @@ GtkPrinter
</para>
@parent_instance:
@priv:
<!-- ##### SIGNAL GtkPrinter::details-acquired ##### -->
<para>
</para>
@printer: the object which received the signal.
@arg1:
<!-- ##### 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:state-message ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_printer_new ##### -->
<para>
</para>
@name:
@backend:
@virtual:
@Returns:

57
docs/reference/gtk/tmpl/gtkprintjob.sgml
View File

@@ -2,20 +2,33 @@
GtkPrintJob
<!-- ##### SECTION Short_Description ##### -->
Represents a print job
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkPrintJob object represents a job that is sent to a
printer. You only need to deal directly with print jobs if
you use the non-portable #GtkPrintUnixDialog API.
</para>
<para>
Use gtk_print_job_get_surface() to obtain the cairo surface
onto which the pages must be drawn. Use gtk_print_job_send()
to send the finished job to the printer. #GtkPrintJob also
supports printing of preexisting PDF documents, via the
gtk_print_job_set_source_file().
<!-- FIXME more details needed here -->
</para>
<!-- FIXME examples ? -->
<para>
Printing support was added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
@@ -24,17 +37,33 @@ GtkPrintJob
</para>
@parent_instance:
@priv:
@print_pages:
@page_ranges:
@num_page_ranges:
@page_set:
@num_copies:
@collate:
@reverse:
@scale:
@rotate_to_orientation:
<!-- ##### SIGNAL GtkPrintJob::status-changed ##### -->
<para>
</para>
@printjob: the object which received the signal.
<!-- ##### ARG GtkPrintJob:page-setup ##### -->
<para>
</para>
<!-- ##### ARG GtkPrintJob:printer ##### -->
<para>
</para>
<!-- ##### ARG GtkPrintJob:settings ##### -->
<para>
</para>
<!-- ##### ARG GtkPrintJob:title ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GtkPrintJobCompleteFunc ##### -->
<para>

24
docs/reference/gtk/tmpl/gtkprintunixdialog.sgml
View File

@@ -2,20 +2,34 @@
GtkPrintUnixDialog
<!-- ##### SECTION Short_Description ##### -->
A print dialog
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkPrintUnixDialog implements a print dialog for platforms
which don't provide a native print dialog, like Unix. It can
be used very much like any other GTK+ dialog, at the cost of
the portability offered by the <link
linkend="gtk-High-level-Printing-API">high-level printing API</link>
</para>
<para>
In order to print something with #GtkPrintUnixDialog, you need
to use gtk_print_unix_dialog_get_selected_printer() to obtain
a #GtkPrinter object and use it to construct a #GtkPrintJob using
gtk_print_job_new().
</para>
<!-- FIXME example here -->
<para>
Printing support was added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkPageSetupUnixDialog, #GtkPrinter, #GtkPrintJob
</para>
<!-- ##### SECTION Stability_Level ##### -->
@@ -24,8 +38,6 @@ GtkPrintUnixDialog
</para>
@parent_instance:
@priv:
<!-- ##### FUNCTION gtk_print_unix_dialog_set_page_setup ##### -->
<para>