diff options
author | Matthias Clasen <mclasen@redhat.com> | 2006-06-29 09:18:07 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2006-06-29 09:18:07 +0000 |
commit | f8f9384537488823076fe6c158d973ef889d4613 (patch) | |
tree | 0959385899794a9879732f5af8d7a00cd57e216e /gtk | |
parent | 65a4b057c475afd4cbf97e6fcffb26232d8acb6b (diff) | |
download | gtk+-f8f9384537488823076fe6c158d973ef889d4613.tar.gz |
Documentation additions and fixes.
2006-06-28 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkprinter.c:
* gtk/gtkprintunixdialog.c:
* gtk/gtkprintoperationpreview.c:
* gtk/gtkprintcontext.c (gtk_print_context_set_cairo_context):
* gtk/gtklabel.c (gtk_label_set_line_wrap_mode):
* gtk/gtkentry.c (gtk_entry_new):
* gtk/gtkprintoperation.c (gtk_print_operation_set_custom_tab_label):
* gtk/gtkclipboard.c (gtk_clipboard_wait_for_rich_text): Documentation
additions and fixes.
* gtk/gtkaspectframe.h:
* gtk/gtkaboutdialog.c:
* gtk/gtkcalendar.c:
* gtk/gtkinputdialog.c:
* gtk/gtk.symbols: Remove unnecessary includes.
* gtk/gtkprogress.[hc]:
* gtk/gtkitemfactory.[hc]: Don't unnecessarily use GTK_COMPILATION,
remove unnecessary includes.
Diffstat (limited to 'gtk')
-rw-r--r-- | gtk/gtk.symbols | 2 | ||||
-rw-r--r-- | gtk/gtkaboutdialog.c | 5 | ||||
-rw-r--r-- | gtk/gtkaspectframe.h | 1 | ||||
-rw-r--r-- | gtk/gtkcalendar.c | 2 | ||||
-rw-r--r-- | gtk/gtkclipboard.c | 1 | ||||
-rw-r--r-- | gtk/gtkentry.c | 7 | ||||
-rw-r--r-- | gtk/gtkinputdialog.c | 5 | ||||
-rw-r--r-- | gtk/gtklabel.c | 2 | ||||
-rw-r--r-- | gtk/gtkprintcontext.c | 21 | ||||
-rw-r--r-- | gtk/gtkprinter.c | 37 | ||||
-rw-r--r-- | gtk/gtkprintoperation.c | 6 | ||||
-rw-r--r-- | gtk/gtkprintoperationpreview.c | 30 | ||||
-rw-r--r-- | gtk/gtkprintunixdialog.c | 12 | ||||
-rw-r--r-- | gtk/gtkprogress.c | 3 | ||||
-rw-r--r-- | gtk/gtkprogress.h | 10 |
15 files changed, 120 insertions, 24 deletions
diff --git a/gtk/gtk.symbols b/gtk/gtk.symbols index fc1983bc61..4de8b47346 100644 --- a/gtk/gtk.symbols +++ b/gtk/gtk.symbols @@ -2870,6 +2870,7 @@ gtk_progress_bar_set_ellipsize #if IN_HEADER(__GTK_PROGRESS_H__) #if IN_FILE(__GTK_PROGRESS_C__) +#ifndef GTK_DISABLE_DEPRECATED gtk_progress_configure gtk_progress_get_current_percentage gtk_progress_get_current_text @@ -2886,6 +2887,7 @@ gtk_progress_set_text_alignment gtk_progress_set_value #endif #endif +#endif #if IN_HEADER(__GTK_RADIO_ACTION_H__) #if IN_FILE(__GTK_RADIO_ACTION_C__) diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c index 2a0d465eaa..01c761c2d5 100644 --- a/gtk/gtkaboutdialog.c +++ b/gtk/gtkaboutdialog.c @@ -30,6 +30,8 @@ #include <config.h> +#include <string.h> + #include <gdk/gdkkeysyms.h> #include "gtkaboutdialog.h" @@ -46,15 +48,12 @@ #include "gtkstock.h" #include "gtktextview.h" #include "gtkvbox.h" -#include "gtkviewport.h" #include "gtkiconfactory.h" #include "gtkprivate.h" #include "gtkintl.h" #include "gtkalias.h" -#include <string.h> - static GdkColor default_link_color = { 0, 0, 0, 0xeeee }; static GdkColor default_visited_link_color = { 0, 0x5555, 0x1a1a, 0x8b8b }; diff --git a/gtk/gtkaspectframe.h b/gtk/gtkaspectframe.h index 437be5e26e..e85888c6e1 100644 --- a/gtk/gtkaspectframe.h +++ b/gtk/gtkaspectframe.h @@ -29,7 +29,6 @@ #include <gdk/gdk.h> -#include <gtk/gtkbin.h> #include <gtk/gtkframe.h> G_BEGIN_DECLS diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c index 90141d5755..23c593006c 100644 --- a/gtk/gtkcalendar.c +++ b/gtk/gtkcalendar.c @@ -47,8 +47,6 @@ #include <windows.h> #endif -#include <glib/gprintf.h> - #undef GTK_DISABLE_DEPRECATED #include "gtkcalendar.h" #define GTK_DISABLE_DEPRECATED diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c index 51b42a4f21..96ebea5bce 100644 --- a/gtk/gtkclipboard.c +++ b/gtk/gtkclipboard.c @@ -1337,6 +1337,7 @@ clipboard_rich_text_received_func (GtkClipboard *clipboard, * gtk_clipboard_wait_for_rich_text: * @clipboard: a #GtkClipboard * @buffer: a #GtkTextBuffer + * @format: return location for the format of the returned data * @length: return location for the length of the returned data * * Requests the contents of the clipboard as rich text. This function diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c index 9e821e57e8..4063d9ceea 100644 --- a/gtk/gtkentry.c +++ b/gtk/gtkentry.c @@ -4059,6 +4059,13 @@ gtk_entry_update_primary_selection (GtkEntry *entry) /* Public API */ +/** + * gtk_entry_new: + * + * Creates a new entry. + * + * Return value: a new #GtkEntry. + */ GtkWidget* gtk_entry_new (void) { diff --git a/gtk/gtkinputdialog.c b/gtk/gtkinputdialog.c index 54fb113b3e..ee685dd0b3 100644 --- a/gtk/gtkinputdialog.c +++ b/gtk/gtkinputdialog.c @@ -33,16 +33,13 @@ #include <config.h> -#include <glib/gprintf.h> #include <stdlib.h> #include "gdk/gdkkeysyms.h" +#include "gtkinputdialog.h" #include "gtkbutton.h" #include "gtkentry.h" #include "gtkhbox.h" -#include "gtkhseparator.h" -#include "gtkinputdialog.h" #include "gtklabel.h" -#include "gtklistitem.h" #include "gtkmain.h" #include "gtkmarshalers.h" #include "gtkmenu.h" diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c index 2a755adc78..8931f95144 100644 --- a/gtk/gtklabel.c +++ b/gtk/gtklabel.c @@ -1721,7 +1721,7 @@ gtk_label_get_line_wrap (GtkLabel *label) /** * gtk_label_set_line_wrap_mode: * @label: a #GtkLabel - * @wrap: the line wrapping mode + * @wrap_mode: the line wrapping mode * * If line wrapping is on (see gtk_label_set_line_wrap()) this controls how * the line wrapping is done. The default is %PANGO_WRAP_WORD which means diff --git a/gtk/gtkprintcontext.c b/gtk/gtkprintcontext.c index 219a830ea6..c1406644e7 100644 --- a/gtk/gtkprintcontext.c +++ b/gtk/gtkprintcontext.c @@ -96,7 +96,22 @@ _gtk_print_context_new (GtkPrintOperation *op) return context; } - +/** + * gtk_print_context_set_cairo_context: + * @context: a #GtkPrintContext + * @cr: the cairo context + * @dpi_x: the horizontal resolution to use with @cr + * @dpi_y: the vertical resolution to use with @cr + * + * Sets a new cairo context on a print context. + * + * This function is intended to be used when implementing + * an internal print preview, it is not needed for printing, + * since GTK+ itself creates a suitable cairo context in that + * case. + * + * Since: 2.10 + */ void gtk_print_context_set_cairo_context (GtkPrintContext *context, cairo_t *cr, @@ -135,7 +150,9 @@ gtk_print_context_set_cairo_context (GtkPrintContext *context, context->pixels_per_unit_x, context->pixels_per_unit_y); - /* We use the unit-scaled resolution, as we still want fonts given in points to work */ + /* We use the unit-scaled resolution, as we still want + * fonts given in points to work + */ pango_cairo_font_map_set_resolution (PANGO_CAIRO_FONT_MAP (context->fontmap), dpi_y / context->pixels_per_unit_y); } diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c index dc5d205948..c0230472aa 100644 --- a/gtk/gtkprinter.c +++ b/gtk/gtkprinter.c @@ -644,6 +644,17 @@ gtk_printer_is_virtual (GtkPrinter *printer) return printer->priv->is_virtual; } +/** + * gtk_printer_accepts_pdf: + * @printer: a #GtkPrinter + * + * Returns whether the printer accepts input in + * PDF format. + * + * Return value: %TRUE if @printer accepts PDF + * + * Since: 2.10 + */ gboolean gtk_printer_accepts_pdf (GtkPrinter *printer) { @@ -652,6 +663,17 @@ gtk_printer_accepts_pdf (GtkPrinter *printer) return printer->priv->accepts_pdf; } +/** + * gtk_printer_accepts_ps: + * @printer: a #GtkPrinter + * + * Returns whether the printer accepts input in + * PostScript format. + * + * Return value: %TRUE if @printer accepts PostScript + * + * Since: 2.10 + */ gboolean gtk_printer_accepts_ps (GtkPrinter *printer) { @@ -790,8 +812,21 @@ _gtk_printer_get_capabilities (GtkPrinter *printer) return backend_class->printer_get_capabilities (printer); } +/** + * gtk_printer_compare: + * @a: a #GtkPrinter + * @b: another #GtkPrinter + * + * Compares two printers. + * + * Return value: 0 if the printer match, a negative value if @a < @b, + * or a positive value if @a > @b + * + * Since: 2.10 + */ gint -gtk_printer_compare (GtkPrinter *a, GtkPrinter *b) +gtk_printer_compare (GtkPrinter *a, + GtkPrinter *b) { const char *name_a, *name_b; diff --git a/gtk/gtkprintoperation.c b/gtk/gtkprintoperation.c index 7667b6e202..995eeff078 100644 --- a/gtk/gtkprintoperation.c +++ b/gtk/gtkprintoperation.c @@ -583,7 +583,7 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class) G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT); /** - * Gtkprintoperation::paginate: + * GtkPrintOperation::paginate: * @operation: the #GtkPrintOperation on which the signal was emitted * @context: the #GtkPrintContext for the current operation * @@ -600,6 +600,8 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class) * it all in the begin-print handler, and set the number of pages * from there. * + * Return value: %TRUE if pagination is complete + * * Since: 2.10 */ signals[PAGINATE] = @@ -1630,7 +1632,7 @@ gtk_print_operation_set_allow_async (GtkPrintOperation *op, /** - * gtk_print_operation_set_custom_tag_label: + * gtk_print_operation_set_custom_tab_label: * @op: a #GtkPrintOperation * @label: the label to use, or %NULL to use the default label * diff --git a/gtk/gtkprintoperationpreview.c b/gtk/gtkprintoperationpreview.c index 776fb36202..a3357cfaf6 100644 --- a/gtk/gtkprintoperationpreview.c +++ b/gtk/gtkprintoperationpreview.c @@ -88,7 +88,15 @@ gtk_print_operation_preview_base_init (gpointer g_iface) } } - +/** + * gtk_print_operation_preview_render_page: + * @preview: a #GtkPrintOperationPreview + * @page_nr: the page to render + * + * Renders a page to the preview. + * + * Since: 2.10 + */ void gtk_print_operation_preview_render_page (GtkPrintOperationPreview *preview, gint page_nr) @@ -99,6 +107,14 @@ gtk_print_operation_preview_render_page (GtkPrintOperationPreview *preview, page_nr); } +/** + * gtk_print_operation_preview_end_preview: + * @preview: a #GtkPrintOperationPreview + * + * Ends a preview. + * + * Since: 2.10 + */ void gtk_print_operation_preview_end_preview (GtkPrintOperationPreview *preview) { @@ -107,6 +123,18 @@ gtk_print_operation_preview_end_preview (GtkPrintOperationPreview *preview) GTK_PRINT_OPERATION_PREVIEW_GET_IFACE (preview)->end_preview (preview); } +/** + * gtk_print_operation_preview_is_selected: + * @preview: a #GtkPrintOperationPreview + * @page_nr: a page number + * + * Returns whether the given page is included in the set of pages that + * have been selected for printing. + * + * Returns: %TRUE if the page has been selected for printing + * + * Since: 2.10 + */ gboolean gtk_print_operation_preview_is_selected (GtkPrintOperationPreview *preview, gint page_nr) diff --git a/gtk/gtkprintunixdialog.c b/gtk/gtkprintunixdialog.c index a15ed4862f..fb485409b4 100644 --- a/gtk/gtkprintunixdialog.c +++ b/gtk/gtkprintunixdialog.c @@ -2680,6 +2680,16 @@ gtk_print_unix_dialog_get_settings (GtkPrintUnixDialog *dialog) return settings; } +/** + * gtk_print_unix_dialog_add_custom_tab: + * @dialog: a #GtkPrintUnixDialog + * @child: the widget to put in the custom tab + * @tab_label: the widget to use as tab label + * + * Adds a custom tab to the print dialog. + * + * Since: 2.10 + */ void gtk_print_unix_dialog_add_custom_tab (GtkPrintUnixDialog *dialog, GtkWidget *child, @@ -2694,7 +2704,7 @@ gtk_print_unix_dialog_add_custom_tab (GtkPrintUnixDialog *dialog, /** * gtk_print_unix_dialog_set_manual_capabilities: * @dialog: a #GtkPrintUnixDialog - * @capabilites: the printing capabilities of your application + * @capabilities: the printing capabilities of your application * * This lets you specify the printing capabilities your application * supports. For instance, if you can handle scaling the output then diff --git a/gtk/gtkprogress.c b/gtk/gtkprogress.c index ba403a6550..023dcdd8e5 100644 --- a/gtk/gtkprogress.c +++ b/gtk/gtkprogress.c @@ -25,10 +25,11 @@ */ #include <config.h> -#include <glib/gprintf.h> #include <math.h> #include <string.h> +#undef GTK_DISABLE_DEPRECATED #include "gtkprogress.h" +#define GTK_DISABLE_DEPRECATED #include "gtkprivate.h" #include "gtkintl.h" #include "gtkalias.h" diff --git a/gtk/gtkprogress.h b/gtk/gtkprogress.h index 4b25942426..76c005f4fb 100644 --- a/gtk/gtkprogress.h +++ b/gtk/gtkprogress.h @@ -35,7 +35,7 @@ G_BEGIN_DECLS -#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION) +#if !defined (GTK_DISABLE_DEPRECATED) #define GTK_TYPE_PROGRESS (gtk_progress_get_type ()) #define GTK_PROGRESS(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_PROGRESS, GtkProgress)) @@ -44,7 +44,7 @@ G_BEGIN_DECLS #define GTK_IS_PROGRESS_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS)) #define GTK_PROGRESS_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_PROGRESS, GtkProgressClass)) -#endif /* !GTK_DISABLE_DEPRECATED || GTK_COMPILATION */ +#endif /* !GTK_DISABLE_DEPRECATED */ typedef struct _GtkProgress GtkProgress; typedef struct _GtkProgressClass GtkProgressClass; @@ -84,7 +84,7 @@ struct _GtkProgressClass * directly. */ -#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION) +#if !defined (GTK_DISABLE_DEPRECATED) GType gtk_progress_get_type (void) G_GNUC_CONST; void gtk_progress_set_show_text (GtkProgress *progress, @@ -98,7 +98,7 @@ void gtk_progress_set_adjustment (GtkProgress *progress, GtkAdjustment *adjustment); void gtk_progress_configure (GtkProgress *progress, gdouble value, - gdouble min, + gdouble hmin, gdouble max); void gtk_progress_set_percentage (GtkProgress *progress, gdouble percentage); @@ -114,7 +114,7 @@ gdouble gtk_progress_get_current_percentage (GtkProgress *progress); gdouble gtk_progress_get_percentage_from_value (GtkProgress *progress, gdouble value); -#endif /* !GTK_DISABLE_DEPRECATED || GTK_COMPILATION */ +#endif /* !GTK_DISABLE_DEPRECATED */ G_END_DECLS |