diff options
author | Matthias Clasen <mclasen@redhat.com> | 2007-05-27 02:32:21 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2007-05-27 02:32:21 +0000 |
commit | 2572a17fd8ab4ace12a3cf34569999d8572b417e (patch) | |
tree | fc79b42da96a76fd9398ae20c20c5ba07ecabd27 /docs/reference | |
parent | fefa9309f000446cc67da06286a6c0cc27ece81d (diff) | |
download | gtk+-2572a17fd8ab4ace12a3cf34569999d8572b417e.tar.gz |
Move docs inline
2007-05-26 Matthias Clasen <mclasen@redhat.com>
* gtk/tmpl/gtkentry.sgml: Move docs inline
* gtk/tmpl/gtklinkbutton.sgml:
* gtk/tmpl/gtkfilechooser.sgml:
* gtk/tmpl/gtkcellrenderer.sgml:
* gtk/tmpl/gtkenums.sgml:
* gtk/tmpl/gtkcontainer.sgml: Additions
svn path=/trunk/; revision=17947
Diffstat (limited to 'docs/reference')
-rw-r--r-- | docs/reference/ChangeLog | 16 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrenderer.sgml | 2 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcontainer.sgml | 10 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkentry.sgml | 82 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkenums.sgml | 14 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilechooser.sgml | 58 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtklinkbutton.sgml | 4 |
7 files changed, 107 insertions, 79 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index dd47712567..8905c14710 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,10 +1,20 @@ 2007-05-26 Matthias Clasen <mclasen@redhat.com> + * gtk/tmpl/gtkentry.sgml: Move docs inline + + * gtk/tmpl/gtklinkbutton.sgml: + * gtk/tmpl/gtkfilechooser.sgml: + * gtk/tmpl/gtkcellrenderer.sgml: + * gtk/tmpl/gtkenums.sgml: + * gtk/tmpl/gtkcontainer.sgml: Additions + +2007-05-26 Matthias Clasen <mclasen@redhat.com> + * gdk/gdk-overrides.txt: Remove GdkBitmap * gtk/gtk-sections.txt: - * gtk/gtkenums.sgml: - * gdk/rgb.sgml: - * gdk/gcs.sgml: + * gtk/tmpl/gtkenums.sgml: + * gdk/tmpl/rgb.sgml: + * gdk/tmpl/gcs.sgml: * gdk/tmpl/pango_interaction.sgml: * gdk/tmpl/windows.sgml: Additions diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml index 5a1db1762a..8f68589312 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml @@ -61,7 +61,7 @@ probably has a selection colored background to render to. @GTK_CELL_RENDERER_PRELIT: The mouse is hovering over the cell. @GTK_CELL_RENDERER_INSENSITIVE: The cell is drawn in an insensitive manner @GTK_CELL_RENDERER_SORTED: The cell is in a sorted row -@GTK_CELL_RENDERER_FOCUSED: +@GTK_CELL_RENDERER_FOCUSED: The cell is in the focus row. <!-- ##### ENUM GtkCellRendererMode ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index 2ba178ec6f..8b3df0e601 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -161,12 +161,14 @@ changes, use gtk_widget_child_notify(). <!-- ##### MACRO GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID ##### --> <para> - +This macro should be used to emit a standard warning about unexpected +properties in set_child_property() and get_child_property() implementations. </para> -@object: -@property_id: -@pspec: +@object: the #GObject on which set_child_property() or get_child_property() + was called +@property_id: the numeric id of the property +@pspec: the #GParamSpec of the property <!-- ##### MACRO gtk_container_border_width ##### --> diff --git a/docs/reference/gtk/tmpl/gtkentry.sgml b/docs/reference/gtk/tmpl/gtkentry.sgml index ce1a75bbe7..289283700d 100644 --- a/docs/reference/gtk/tmpl/gtkentry.sgml +++ b/docs/reference/gtk/tmpl/gtkentry.sgml @@ -186,10 +186,6 @@ The #GtkEntry-struct struct contains only private data. </para> -<para> -Creates a new #GtkEntry widget. -</para> - <!-- ##### ARG GtkEntry:inner-border ##### --> <para> @@ -213,54 +209,38 @@ Creates a new #GtkEntry widget. <!-- ##### FUNCTION gtk_entry_set_text ##### --> <para> -Sets the text in the widget to the given -value, replacing the current contents. + </para> -@entry: a #GtkEntry. -@text: the new text. +@entry: +@text: <!-- ##### FUNCTION gtk_entry_append_text ##### --> <para> -Appends the given text to the contents of the widget. + </para> -@entry: a #GtkEntry. -@text: the text to append. -@Deprecated: gtk_entry_append_text() is deprecated and should not - be used in newly-written code. Use gtk_editable_insert_text() - instead. +@entry: +@text: <!-- ##### FUNCTION gtk_entry_prepend_text ##### --> <para> -Prepends the given text to the contents of the widget. + </para> -@entry: a #GtkEntry. -@text: the text to prepend. -@Deprecated: gtk_entry_prepend_text() is deprecated and should not - be used in newly-written code. Use gtk_editable_insert_text() - instead. +@entry: +@text: <!-- ##### FUNCTION gtk_entry_set_position ##### --> <para> -Sets the cursor position in an entry to the given -value. This function is obsolete. You should use -gtk_editable_set_position() instead. + </para> -@entry: a #GtkEntry. -@position: the position of the cursor. The cursor is displayed - before the character with the given (base 0) index - in the widget. The value must be less than or - equal to the number of characters in the widget. - A value of -1 indicates that the position should - be set after the last character in the entry. - Note that this position is in characters, not in - bytes. +@entry: +@position: <!-- ##### FUNCTION gtk_entry_get_text ##### --> @@ -274,36 +254,21 @@ gtk_editable_set_position() instead. <!-- ##### FUNCTION gtk_entry_select_region ##### --> <para> -Selects a region of text. The characters that -are selected are those characters at positions from -@start_pos up to, but not including @end_pos. If -@end_pos is negative, then the the characters selected -will be those characters from @start_pos to the end -of the text. This function is obsolete. You should -use gtk_editable_select_region() instead. + </para> -@entry: a #GtkEntry. -@start: the starting position. -@end: the end position. +@entry: +@start: +@end: <!-- ##### FUNCTION gtk_entry_set_visibility ##### --> <para> -Sets whether the contents of the entry are visible or -not. When visibility is set to %FALSE, characters -are displayed as the invisible char, and will also appear -that way when the text in the entry widget is copied -elsewhere. -</para> -<para> -The default invisible char is the asterisk '*', but it can -be changed with gtk_entry_set_invisible_char(). + </para> -@entry: a #GtkEntry. -@visible: %TRUE if the contents of the entry are displayed - as plaintext. +@entry: +@visible: <!-- ##### FUNCTION gtk_entry_set_invisible_char ##### --> @@ -317,14 +282,11 @@ be changed with gtk_entry_set_invisible_char(). <!-- ##### FUNCTION gtk_entry_set_editable ##### --> <para> -Determines if the user can edit the text in the editable -widget or not. This function is obsolete. You should -use gtk_editable_set_editable() instead. + </para> -@entry: a #GtkEntry. -@editable: %TRUE if the user is allowed to edit the text - in the widget. +@entry: +@editable: <!-- ##### FUNCTION gtk_entry_set_max_length ##### --> diff --git a/docs/reference/gtk/tmpl/gtkenums.sgml b/docs/reference/gtk/tmpl/gtkenums.sgml index b1e551033a..b97ab628e5 100644 --- a/docs/reference/gtk/tmpl/gtkenums.sgml +++ b/docs/reference/gtk/tmpl/gtkenums.sgml @@ -78,13 +78,13 @@ contains. (See also: #GtkVButtonBox and #GtkHButtonBox). </para> @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing. -@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox. -@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox. -@GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the -left for a HBox, or the top for a VBox). -@GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the -right for a HBox, or the bottom for a VBox). -@GTK_BUTTONBOX_CENTER: +@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box. +@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box. +@GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box, + (on the left for a HBox, or the top for a VBox). +@GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box, + (on the right for a HBox, or the bottom for a VBox). +@GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12 <!-- ##### ENUM GtkCornerType ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkfilechooser.sgml b/docs/reference/gtk/tmpl/gtkfilechooser.sgml index ccaffe48fb..a24691a912 100644 --- a/docs/reference/gtk/tmpl/gtkfilechooser.sgml +++ b/docs/reference/gtk/tmpl/gtkfilechooser.sgml @@ -672,6 +672,61 @@ gtk_widget_destroy (chooser); @filechooser: the object which received the signal. +<!-- ##### ARG GtkFileChooser:action ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:do-overwrite-confirmation ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:extra-widget ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:file-system-backend ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:filter ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:local-only ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:preview-widget ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:preview-widget-active ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:select-multiple ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:show-hidden ##### --> +<para> + +</para> + +<!-- ##### ARG GtkFileChooser:use-preview-label ##### --> +<para> + +</para> + <!-- ##### ENUM GtkFileChooserAction ##### --> <para> Describes whether a #GtkFileChooser is being used to open @@ -726,7 +781,8 @@ gtk_widget_destroy (chooser); @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist. @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename. -@GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: +@GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: Indicates a duplicate path (e.g. when + adding a bookmark). <!-- ##### FUNCTION gtk_file_chooser_set_action ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtklinkbutton.sgml b/docs/reference/gtk/tmpl/gtklinkbutton.sgml index ed9b23dab0..9b3d376f31 100644 --- a/docs/reference/gtk/tmpl/gtklinkbutton.sgml +++ b/docs/reference/gtk/tmpl/gtklinkbutton.sgml @@ -96,9 +96,7 @@ clicked. @button: the #GtkLinkButton which was clicked @link: the URI to which the clicked #GtkLinkButton points -@user_data: -<!-- # Unused Parameters # --> -@data: user data that was passed when the function was registered +@user_data: user data that was passed when the function was registered with gtk_link_button_set_uri_hook() |