mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-09-30 02:57:38 +00:00
docs: Move documentation to inline comments: GtkPaned
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=634338 Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Patrick Bernaud
Tristan Van Berkom
parent
a00a0fb209
commit
8eb7181979
1
docs/reference/gtk/tmpl/.gitignore
vendored
1
docs/reference/gtk/tmpl/.gitignore
vendored
@ -32,6 +32,7 @@ gtkobject.sgml
|
||||
gtkorientable.sgml
|
||||
gtkpagesetup.sgml
|
||||
gtkpagesetupunixdialog.sgml
|
||||
gtkpaned.sgml
|
||||
gtkpapersize.sgml
|
||||
gtkprinter.sgml
|
||||
gtkprogressbar.sgml
|
||||
|
||||
@ -1,272 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkPaned
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Base class for widgets with two adjustable panes
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
#GtkPaned is the base class for widgets with two panes,
|
||||
arranged either horizontally (#GtkHPaned) or
|
||||
vertically (#GtkVPaned). Child widgets are
|
||||
added to the panes of the widget with
|
||||
gtk_paned_pack1() and gtk_paned_pack2(). The division
|
||||
beween the two children is set by default from the
|
||||
size requests of the children, but it can be adjusted
|
||||
by the user.
|
||||
</para>
|
||||
<para>
|
||||
A paned widget draws a separator between the two
|
||||
child widgets and a small handle that the user
|
||||
can drag to adjust the division. It does not
|
||||
draw any relief around the children or around
|
||||
the separator. (The space in which the separator
|
||||
is called the gutter.) Often, it is useful
|
||||
to put each child inside a #GtkFrame with the
|
||||
shadow type set to %GTK_SHADOW_IN so that the
|
||||
gutter appears as a ridge. No separator is drawn
|
||||
if one of the children is missing.
|
||||
</para>
|
||||
<para>
|
||||
Each child has two options that can be set,
|
||||
@resize and @shrink. If @resize is true, then when the
|
||||
#GtkPaned is resized, that child will expand
|
||||
or shrink along with the paned widget. If @shrink
|
||||
is true, then when that child can be made smaller
|
||||
than its requisition by the user. Setting @shrink
|
||||
to %FALSE allows the application to set a minimum
|
||||
size. If @resize is false for both children, then
|
||||
this is treated as if @resize is true for both
|
||||
children.
|
||||
</para>
|
||||
<para>
|
||||
The application can set the position of the slider
|
||||
as if it were set by the user, by calling
|
||||
gtk_paned_set_position().
|
||||
</para>
|
||||
|
||||
<example>
|
||||
<title>Creating a paned widget with minimum sizes.</title>
|
||||
<programlisting>
|
||||
GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
|
||||
GtkWidget *frame1 = gtk_frame_new (NULL);
|
||||
GtkWidget *frame2 = gtk_frame_new (NULL);
|
||||
gtk_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
|
||||
gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);
|
||||
|
||||
gtk_widget_set_size_request (hpaned, 200, -1);
|
||||
|
||||
gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
|
||||
gtk_widget_set_size_request (frame1, 50, -1);
|
||||
|
||||
gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
|
||||
gtk_widget_set_size_request (frame2, 50, -1);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT GtkPaned ##### -->
|
||||
<para>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::accept-position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned: the object which received the signal.
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::cancel-position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned: the object which received the signal.
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::cycle-child-focus ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
@Param4:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@paned: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::cycle-handle-focus ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
@Param4:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@paned: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::move-handle ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
@Param4:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@paned: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkPaned::toggle-handle-focus ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned: the object which received the signal.
|
||||
@Returns:
|
||||
|
||||
<!-- ##### ARG GtkPaned:max-position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:min-position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:position-set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:shrink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkPaned:handle-size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@orientation:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_add1 ##### -->
|
||||
<para>
|
||||
Adds a child to the top or left pane with
|
||||
default parameters. This is equivalent
|
||||
to <literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
|
||||
</para>
|
||||
|
||||
@paned: a paned widget
|
||||
@child: the child to add
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_add2 ##### -->
|
||||
<para>
|
||||
Adds a child to the bottom or right pane with default
|
||||
parameters. This is equivalent to
|
||||
<literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
|
||||
</para>
|
||||
|
||||
@paned: a paned widget
|
||||
@child: the child to add
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_pack1 ##### -->
|
||||
<para>
|
||||
Adds a child to the top or left pane.
|
||||
</para>
|
||||
|
||||
@paned: a paned widget
|
||||
@child: the child to add
|
||||
@resize: should this child expand when the paned widget is resized.
|
||||
@shrink: can this child be made smaller than its requisition.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_pack2 ##### -->
|
||||
<para>
|
||||
Adds a child to the bottom or right pane.
|
||||
</para>
|
||||
|
||||
@paned: a paned widget
|
||||
@child: the child to add
|
||||
@resize: should this child expand when the paned widget is resized.
|
||||
@shrink: can this child be made smaller than its requisition.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_get_child1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_get_child2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_set_position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned:
|
||||
@position:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_get_position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_paned_get_handle_window ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@paned:
|
||||
@Returns:
|
||||
|
||||
|
||||
@ -39,6 +39,56 @@
|
||||
#include "gtkintl.h"
|
||||
|
||||
|
||||
/**
|
||||
* SECTION:gtkpaned
|
||||
* @Short_description: Base class for widgets with two adjustable panes
|
||||
* @Title: GtkPaned
|
||||
*
|
||||
* #GtkPaned is the base class for widgets with two panes, arranged either
|
||||
* horizontally (#GtkHPaned) or vertically (#GtkVPaned). Child widgets are
|
||||
* added to the panes of the widget with gtk_paned_pack1() and
|
||||
* gtk_paned_pack2(). The division between the two children is set by default
|
||||
* from the size requests of the children, but it can be adjusted by the
|
||||
* user.
|
||||
*
|
||||
* A paned widget draws a separator between the two child widgets and a
|
||||
* small handle that the user can drag to adjust the division. It does not
|
||||
* draw any relief around the children or around the separator. (The space
|
||||
* in which the separator is called the gutter.) Often, it is useful to put
|
||||
* each child inside a #GtkFrame with the shadow type set to %GTK_SHADOW_IN
|
||||
* so that the gutter appears as a ridge. No separator is drawn if one of
|
||||
* the children is missing.
|
||||
*
|
||||
* Each child has two options that can be set, @resize and @shrink. If
|
||||
* @resize is true, then when the #GtkPaned is resized, that child will
|
||||
* expand or shrink along with the paned widget. If @shrink is true, then
|
||||
* that child can be made smaller than its requisition by the user.
|
||||
* Setting @shrink to %FALSE allows the application to set a minimum size.
|
||||
* If @resize is false for both children, then this is treated as if
|
||||
* @resize is true for both children.
|
||||
*
|
||||
* The application can set the position of the slider as if it were set
|
||||
* by the user, by calling gtk_paned_set_position().
|
||||
*
|
||||
* <example>
|
||||
* <title>Creating a paned widget with minimum sizes.</title>
|
||||
* <programlisting>
|
||||
* GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
|
||||
* GtkWidget *frame1 = gtk_frame_new (NULL);
|
||||
* GtkWidget *frame2 = gtk_frame_new (NULL);
|
||||
* gtk_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
|
||||
* gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);
|
||||
*
|
||||
* gtk_widget_set_size_request (hpaned, 200, -1);
|
||||
*
|
||||
* gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
|
||||
* gtk_widget_set_size_request (frame1, 50, -1);
|
||||
*
|
||||
* gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
|
||||
* gtk_widget_set_size_request (frame2, 50, -1);
|
||||
* </programlisting>
|
||||
* </example>
|
||||
*/
|
||||
|
||||
struct _GtkPanedPrivate
|
||||
{
|
||||
@ -1444,6 +1494,15 @@ gtk_paned_new (GtkOrientation orientation)
|
||||
NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
* gtk_paned_add1:
|
||||
* @paned: a paned widget
|
||||
* @child: the child to add
|
||||
*
|
||||
* Adds a child to the top or left pane with default parameters. This is
|
||||
* equivalent to
|
||||
* <literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
|
||||
*/
|
||||
void
|
||||
gtk_paned_add1 (GtkPaned *paned,
|
||||
GtkWidget *widget)
|
||||
@ -1451,6 +1510,15 @@ gtk_paned_add1 (GtkPaned *paned,
|
||||
gtk_paned_pack1 (paned, widget, FALSE, TRUE);
|
||||
}
|
||||
|
||||
/**
|
||||
* gtk_paned_add2:
|
||||
* @paned: a paned widget
|
||||
* @child: the child to add
|
||||
*
|
||||
* Adds a child to the bottom or right pane with default parameters. This
|
||||
* is equivalent to
|
||||
* <literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
|
||||
*/
|
||||
void
|
||||
gtk_paned_add2 (GtkPaned *paned,
|
||||
GtkWidget *widget)
|
||||
@ -1458,6 +1526,15 @@ gtk_paned_add2 (GtkPaned *paned,
|
||||
gtk_paned_pack2 (paned, widget, TRUE, TRUE);
|
||||
}
|
||||
|
||||
/**
|
||||
* gtk_paned_pack1:
|
||||
* @paned: a paned widget
|
||||
* @child: the child to add
|
||||
* @resize: should this child expand when the paned widget is resized.
|
||||
* @shrink: can this child be made smaller than its requisition.
|
||||
*
|
||||
* Adds a child to the top or left pane.
|
||||
*/
|
||||
void
|
||||
gtk_paned_pack1 (GtkPaned *paned,
|
||||
GtkWidget *child,
|
||||
@ -1481,6 +1558,15 @@ gtk_paned_pack1 (GtkPaned *paned,
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* gtk_paned_pack2:
|
||||
* @paned: a paned widget
|
||||
* @child: the child to add
|
||||
* @resize: should this child expand when the paned widget is resized.
|
||||
* @shrink: can this child be made smaller than its requisition.
|
||||
*
|
||||
* Adds a child to the bottom or right pane.
|
||||
*/
|
||||
void
|
||||
gtk_paned_pack2 (GtkPaned *paned,
|
||||
GtkWidget *child,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user