AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-05 16:20:10 +00:00
Code Issues Projects Releases Wiki Activity

[docs] Move documentation to inline comments: GtkArrow

Browse Source 
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611957

Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Javier Jardón 2010-04-18 17:48:02 +02:00
parent c3d5faf6b7
commit 508ed4bbab
2 changed files with 37 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
docs/reference/gtk/tmpl/gtkarrow.sgml
View File

@ -1,82 +0,0 @@
<!-- ##### SECTION Title ##### -->
GtkArrow
<!-- ##### SECTION Short_Description ##### -->
Displays an arrow
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkArrow should be used to draw simple arrows that need to point in
one of the four cardinal directions (up, down, left, or right). The
style of the arrow can be one of shadow in, shadow out, etched in, or
etched out. Note that these directions and style types may be
ammended in versions of Gtk to come.
</para>
<para>
GtkArrow will fill any space alloted to it, but since it is inherited
from #GtkMisc, it can be padded and/or aligned, to fill exactly the
space the programmer desires.
</para>
<para>
Arrows are created with a call to gtk_arrow_new(). The direction or
style of an arrow can be changed after creation by using gtk_arrow_set().
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>gtk_paint_arrow()</term>
<listitem><para>the function used internally to paint the arrow.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkArrow ##### -->
<para>
The #GtkArrow struct containes the following fields.
(These fields should be considered read-only. They should never be set by
an application.)
</para>
<!-- ##### ARG GtkArrow:arrow-type ##### -->
<para>
</para>
<!-- ##### ARG GtkArrow:shadow-type ##### -->
<para>
</para>
<!-- ##### ARG GtkArrow:arrow-scaling ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_arrow_new ##### -->
<para>
Creates a new arrow widget.
</para>
@arrow_type: a valid #GtkArrowType.
@shadow_type: a valid #GtkShadowType.
@Returns: the new #GtkArrow widget.
<!-- ##### FUNCTION gtk_arrow_set ##### -->
<para>
Sets the direction and style of the #GtkArrow, @arrow.
</para>
@arrow: a widget of type #GtkArrow.
@arrow_type: a valid #GtkArrowType.
@shadow_type: a valid #GtkShadowType.

37
gtk/gtkarrow.c
View File

@ -24,6 +24,26 @@
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
/**
* SECTION:gtkarrow
* @Short_description: Displays an arrow
* @Title: GtkArrow
* @See_also: gtk_paint_arrow()
*
* GtkArrow should be used to draw simple arrows that need to point in
* one of the four cardinal directions (up, down, left, or right). The
* style of the arrow can be one of shadow in, shadow out, etched in, or
* etched out. Note that these directions and style types may be
* ammended in versions of GTK+ to come.
*
* GtkArrow will fill any space alloted to it, but since it is inherited
* from #GtkMisc, it can be padded and/or aligned, to fill exactly the
* space the programmer desires.
*
* Arrows are created with a call to gtk_arrow_new(). The direction or
* style of an arrow can be changed after creation by using gtk_arrow_set().
*/
#include "config.h"
#include <math.h>
#include "gtkarrow.h"
@ -155,6 +175,15 @@ gtk_arrow_init (GtkArrow *arrow)
arrow->shadow_type = GTK_SHADOW_OUT;
}
/**
* gtk_arrow_new:
* @arrow_type: a valid #GtkArrowType.
* @shadow_type: a valid #GtkShadowType.
*
* Creates a new #GtkArrow widget.
*
* Returns: the new #GtkArrow widget.
*/
GtkWidget*
gtk_arrow_new (GtkArrowType arrow_type,
GtkShadowType shadow_type)
@ -169,6 +198,14 @@ gtk_arrow_new (GtkArrowType arrow_type,
return GTK_WIDGET (arrow);
}
/**
* gtk_arrow_set:
* @arrow: a widget of type #GtkArrow.
* @arrow_type: a valid #GtkArrowType.
* @shadow_type: a valid #GtkShadowType.
*
* Sets the direction and style of the #GtkArrow, @arrow.
*/
void
gtk_arrow_set (GtkArrow *arrow,
GtkArrowType arrow_type,