Commit c27900c3 authored by Matthias Clasen's avatar Matthias Clasen

Documentation updates.

        * gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
        gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
        gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.

        * docs/reference/gtk/tmpl/gtkmenuitem.sgml,
        docs/reference/gtk/tmpl/gtkmenu.sgml,
        docs/reference/gtk/tmpl/gtkmenushell.sgml,
        docs/reference/gtk/tmpl/gtkcontainer.sgml,
        docs/reference/gtk/gtk-sections.txt: Updates.
parent 48298c1d
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
2001-10-28 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkcellrenderertoggle.c, gtk/gtkimcontextsimple.c,
gtk/gtkimmulticontext.c, gtk/gtkimagemenuitem.c,
gtk/gtkiconfactory.c, gtk/gtkwindow.c: Documentation updates.
2001-10-28 jacob berkman <jacob@ximian.com>
* gtk/gtkcolorsel.c (gtk_color_selection_class_init): do not call
......
This diff is collapsed.
......@@ -40,11 +40,10 @@ GtkContainer
<!-- ##### MACRO gtk_container_border_width ##### -->
<para>
Does the same as gtk_container_get_border_width().
</para>
<!-- ##### FUNCTION gtk_container_add ##### -->
<para>
......@@ -124,7 +123,7 @@ GtkContainer
<!-- ##### MACRO gtk_container_children ##### -->
<para>
Does the same as gtk_container_get_children().
</para>
@Returns:
......
......@@ -170,11 +170,12 @@ Set the #GtkAccelGroup which holds global accelerators for the menu.
<!-- ##### FUNCTION gtk_menu_get_accel_group ##### -->
<para>
Gets the #GtkAccelGroup which holds global accelerators for the menu.
See gtk_menu_set_accel_group().
</para>
@menu:
@Returns:
@menu: a #GtkMenu.
@Returns: the #GtkAccelGroup associated with the menu.
<!-- ##### FUNCTION gtk_menu_set_title ##### -->
......
......@@ -119,20 +119,20 @@ Emits the "activate" signal on the given item
<!-- ##### FUNCTION gtk_menu_item_toggle_size_request ##### -->
<para>
Emits the "toggle_size_request" signal on the given item.
</para>
@menu_item:
@requisition:
@menu_item: the menu item
@requisition: the requisition to use as signal data.
<!-- ##### FUNCTION gtk_menu_item_toggle_size_allocate ##### -->
<para>
Emits the "toggle_size_allocate" signal on the given item.
</para>
@menu_item:
@allocation:
@menu_item: the menu item.
@allocation: the allocation to use as signal data.
<!-- ##### MACRO gtk_menu_item_right_justify ##### -->
......
......@@ -91,10 +91,10 @@ Selects the menu item from the menu shell.
<!-- ##### FUNCTION gtk_menu_shell_deselect ##### -->
<para>
Deselects the currently selected item from the menu shell, if any.
</para>
@menu_shell:
@menu_shell: a #GtkMenuShell.
<!-- ##### FUNCTION gtk_menu_shell_activate_item ##### -->
......
......@@ -380,6 +380,8 @@ gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle,
/**
* gtk_cell_renderer_toggle_get_radio:
* @toggle: a #GtkCellRendererToggle
*
* Returns wether we're rendering radio toggles rather than checkboxes.
*
* Return value: %TRUE if we're rendering radio toggles rather than checkboxes
**/
......@@ -391,6 +393,15 @@ gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle)
return toggle->radio;
}
/**
* gtk_cell_renderer_toggle_get_active:
* @check_menu_item: a #GtkCellRendererToggle
*
* Returns whether the cell renderer is active. See
* gtk_cell_renderer_toggle_set_active().
*
* Return value: %TRUE if the cell renderer is active.
gboolean
gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle)
{
......@@ -399,6 +410,13 @@ gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle)
return toggle->active;
}
/**
* gtk_cell_renderer_toggle_set_active:
* @toggle: a #GtkCellRendererToggle.
* @setting: the value to set.
*
* Activates or deactivates a cell renderer.
**/
void
gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle,
gboolean setting)
......
......@@ -514,6 +514,7 @@ get_default_icons (GtkIconFactory *factory)
add_unsized (factory, stock_convert, GTK_STOCK_CONVERT);
add_unsized (factory, stock_copy, GTK_STOCK_COPY);
add_unsized (factory, stock_cut, GTK_STOCK_CUT);
add_unsized (factory, stock_delete, GTK_STOCK_DELETE);
add_unsized (factory, stock_down_arrow, GTK_STOCK_GO_DOWN);
add_unsized (factory, stock_exec, GTK_STOCK_EXECUTE);
add_unsized (factory, stock_exit, GTK_STOCK_QUIT);
......@@ -548,7 +549,7 @@ get_default_icons (GtkIconFactory *factory)
add_unsized (factory, stock_text_strikeout, GTK_STOCK_STRIKETHROUGH);
add_unsized (factory, stock_text_underline, GTK_STOCK_UNDERLINE);
add_unsized (factory, stock_top, GTK_STOCK_GOTO_TOP);
add_unsized (factory, stock_trash, GTK_STOCK_DELETE);
add_unsized (factory, stock_trash, GTK_STOCK_TRASHCAN);
add_unsized (factory, stock_undelete, GTK_STOCK_UNDELETE);
add_unsized (factory, stock_undo, GTK_STOCK_UNDO);
add_unsized (factory, stock_up_arrow, GTK_STOCK_GO_UP);
......@@ -768,6 +769,13 @@ gtk_icon_size_register_alias (const gchar *alias,
g_hash_table_insert (icon_aliases, ia->name, ia);
}
/**
* gtk_icon_size_from_name:
* @name: the name to look up.
* @returns: the icon size with the given name.
*
* Looks up the icon size associated with @name.
**/
GtkIconSize
gtk_icon_size_from_name (const gchar *name)
{
......@@ -783,6 +791,14 @@ gtk_icon_size_from_name (const gchar *name)
return GTK_ICON_SIZE_INVALID;
}
/**
* gtk_icon_size_get_name:
* @size: a #GtkIconSize.
* @returns: the name of the given icon size.
*
* Gets the canonical name of the given icon size. The returned string
* is statically allocated and should not be freed.
**/
G_CONST_RETURN gchar*
gtk_icon_size_get_name (GtkIconSize size)
{
......
......@@ -284,12 +284,25 @@ gtk_image_menu_item_forall (GtkContainer *container,
(* callback) (image_menu_item->image, callback_data);
}
/**
* gtk_image_menu_item_new:
* @returns: a new #GtkImageMenuItem.
*
* Creates a new #GtkImageMenuItem with an empty label.
**/
GtkWidget*
gtk_image_menu_item_new (void)
{
return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
}
/**
* gtk_image_menu_item_new_with_label:
* @label: the text of the menu item.
* @returns: a new #GtkImageMenuItem.
*
* Creates a new #GtkImageMenuItem containing a label.
**/
GtkWidget*
gtk_image_menu_item_new_with_label (const gchar *label)
{
......@@ -313,7 +326,7 @@ gtk_image_menu_item_new_with_label (const gchar *label)
/**
* gtk_image_menu_item_new_with_mnemonic:
* @label: The text of the button, with an underscore in front of the
* @label: the text of the menu item, with an underscore in front of the
* mnemonic character
* @returns: a new #GtkImageMenuItem
*
......@@ -342,6 +355,16 @@ gtk_image_menu_item_new_with_mnemonic (const gchar *label)
return GTK_WIDGET(image_menu_item);
}
/**
* gtk_image_menu_item_new_from_stock:
* @stock_id: the name of the stock item.
* @accel_group: the #GtkAccelGroup to add the menu items accelerator to.
* @returns: a new #GtkImageMenuItem.
*
* Creates a new #GtkImageMenuItem containing the image and text from a
* stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
* and #GTK_STOCK_APPLY.
**/
GtkWidget*
gtk_image_menu_item_new_from_stock (const gchar *stock_id,
GtkAccelGroup *accel_group)
......@@ -379,6 +402,13 @@ gtk_image_menu_item_new_from_stock (const gchar *stock_id,
return item;
}
/**
* gtk_image_menu_item_set_image:
* @image_menu_item: a #GtkImageMenuItem.
* @image: a widget to set as the image for the menu item.
*
* Sets the image of @image_menu_item to the given widget.
**/
void
gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
GtkWidget *image)
......@@ -402,6 +432,14 @@ gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
g_object_notify (G_OBJECT (image_menu_item), "image");
}
/**
* gtk_image_menu_item_get_image:
* @image_menu_item: a #GtkImageMenuItem.
* @returns: the widget set as image of @image_menu_item.
*
* Gets the widget that is currently set as the image of @image_menu_item.
* See gtk_image_menu_item_set_image().
**/
GtkWidget*
gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
{
......
......@@ -38,7 +38,7 @@ struct _GtkComposeTable
* to obtain the relevant perl scripts.
*
* The following compose letter letter sequences confliced
* Dstroke/dstroke and ETH/eth; resolved to Dstroke (Croation, Vietnamese, Lappish), over
* Dstroke/dstroke and ETH/eth; resolved to Dstroke (Croation, Vietnamese, Lappish), over
* ETH (Icelandic, Faroese, old English, IPA) [ D- -D d- -d ]
* Amacron/amacron and ordfeminine; resolved to ordfeminine [ _A A_ a_ _a ]
* Amacron/amacron and Atilde/atilde; resolved to atilde [ -A A- a- -a ]
......@@ -817,6 +817,13 @@ gtk_im_context_simple_finalize (GObject *obj)
parent_class->finalize (obj);
}
/**
* gtk_im_context_simple_new:
*
* Creates a new #GtkIMContextSimple.
*
* Returns: a new #GtkIMContextSimple.
**/
GtkIMContext *
gtk_im_context_simple_new (void)
{
......
......@@ -113,6 +113,13 @@ gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
multicontext->slave = NULL;
}
/**
* gtk_im_multicontext_new:
*
* Creates a new #GtkIMMulticontext.
*
* Returns: a new #GtkIMMulticontext.
**/
GtkIMContext *
gtk_im_multicontext_new (void)
{
......
......@@ -29,14 +29,6 @@
#include "gdk/gdk.h"
#include "gdk/gdkkeysyms.h"
#if defined (GDK_WINDOWING_X11)
#include "x11/gdkx.h"
#elif defined (GDK_WINDOWING_WIN32)
#include "win32/gdkwin32.h"
#elif defined (GDK_WINDOWING_FB)
#include "linux-fb/gdkfb.h"
#endif
#include "gtkprivate.h"
#include "gtkrc.h"
#include "gtksignal.h"
......@@ -5134,7 +5126,7 @@ window_group_cleanup_grabs (GtkWindowGroup *group,
}
/**
* gtk_window_group_add_widget:
* gtk_window_group_add_window:
* @window_group: a #GtkWindowGroup
* @window: the #GtkWindow to add
*
......
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