Commit 83195856 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkToggleAction

parent 45434cc6
......@@ -7,4 +7,5 @@ gtkpagesetupunixdialog.sgml
gtkseparator.sgml
gtktesting.sgml
gtktextiter.sgml
gtktoggleaction.sgml
gtktoolitem.sgml
<!-- ##### SECTION Title ##### -->
GtkToggleAction
<!-- ##### SECTION Short_Description ##### -->
An action which can be toggled between two states
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an
"active" state specifying whether the action has been checked or not.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkToggleAction ##### -->
<para>
The <structname>GtkToggleAction</structname> struct contains only
private members and should not be accessed directly.
</para>
<!-- ##### SIGNAL GtkToggleAction::toggled ##### -->
<para>
</para>
@toggleaction: the object which received the signal.
<!-- ##### ARG GtkToggleAction:active ##### -->
<para>
</para>
<!-- ##### ARG GtkToggleAction:draw-as-radio ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_toggle_action_new ##### -->
<para>
</para>
@name:
@label:
@tooltip:
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_toggle_action_toggled ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION gtk_toggle_action_set_active ##### -->
<para>
</para>
@action:
@is_active:
<!-- ##### FUNCTION gtk_toggle_action_get_active ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION gtk_toggle_action_set_draw_as_radio ##### -->
<para>
</para>
@action:
@draw_as_radio:
<!-- ##### FUNCTION gtk_toggle_action_get_draw_as_radio ##### -->
<para>
</para>
@action:
@Returns:
......@@ -39,6 +39,17 @@
#include "gtkprivate.h"
#include "gtkalias.h"
/**
* SECTION:gtktoggleaction
* @Short_description: An action which can be toggled between two states
* @Title: GtkToggleAction
*
* A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an
* "active" state specifying whether the action has been checked or not.
*/
enum
{
TOGGLED,
......@@ -120,7 +131,13 @@ gtk_toggle_action_class_init (GtkToggleActionClass *klass)
P_("If the toggle action should be active in or not"),
FALSE,
GTK_PARAM_READWRITE));
/**
* GtkToggleAction::toggled:
* @toggleaction: the object which received the signal.
*
* Should be connected if you wish to perform an action
* whenever the #GtkToggleAction state is changed.
*/
action_signals[TOGGLED] =
g_signal_new (I_("toggled"),
G_OBJECT_CLASS_TYPE (klass),
......@@ -275,7 +292,7 @@ gtk_toggle_action_set_active (GtkToggleAction *action,
* @action: the action object
*
* Returns the checked state of the toggle action.
*
* Returns: the checked state of the toggle action
*
* Since: 2.4
......
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