Commit f8f93845 authored by Matthias Clasen's avatar Matthias Clasen Committed by Matthias Clasen

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.
parent 65a4b057
2006-06-28 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkitemfactory.[hc]: Don't unnecessarily use
GTK_COMPILATION.
* 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.
* gdk/x11/gdkdisplay-x11.c (gdk_display_open): Only select the
XKB event details we actually care about. (#346079, Ryan Lortie)
......
2006-06-28 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkitemfactory.[hc]: Don't unnecessarily use
GTK_COMPILATION.
* 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.
* gdk/x11/gdkdisplay-x11.c (gdk_display_open): Only select the
XKB event details we actually care about. (#346079, Ryan Lortie)
......
......@@ -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__)
......
......@@ -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 };
......
......@@ -29,7 +29,6 @@
#include <gdk/gdk.h>
#include <gtk/gtkbin.h>
#include <gtk/gtkframe.h>
G_BEGIN_DECLS
......
......@@ -47,8 +47,6 @@
#include <windows.h>
#endif
#include <glib/gprintf.h>
#undef GTK_DISABLE_DEPRECATED
#include "gtkcalendar.h"
#define GTK_DISABLE_DEPRECATED
......
......@@ -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
......
......@@ -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)
{
......
......@@ -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"
......
......@@ -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
......
......@@ -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);
}
......
......@@ -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 &lt; @b,
* or a positive value if @a &gt; @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;
......
......@@ -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
*
......
......@@ -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)
......
......@@ -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
......
......@@ -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"
......
......@@ -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
......
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