/**
* GtkPaned:
*
- * `GtkPaned` has two panes, arranged either horizontally or vertically.
+ * A widget with two panes, arranged either horizontally or vertically.
*
* 
*
* each child inside a [class@Gtk.Frame] 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
+ * 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.
+ * 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 [method@Gtk.Paned.set_position].
/**
* GtkPaned:position-set:
*
- * %TRUE if the `position` property has been set.
+ * Whether the [property@Gtk.Paned:position] property has been set.
*/
paned_props[PROP_POSITION_SET] =
g_param_spec_boolean ("position-set",
/**
* GtkPaned:min-position:
*
- * The smallest possible value for the position property.
+ * The smallest possible value for the [property@Gtk.Paned:position]
+ * property.
*
* This property is derived from the size and shrinkability
* of the widget's children.
/**
* GtkPaned:max-position:
*
- * The largest possible value for the position property.
+ * The largest possible value for the [property@Gtk.Paned:position]
+ * property.
*
* This property is derived from the size and shrinkability
* of the widget's children.
*
* This is a [keybinding signal](class.SignalAction.html).
*
- * The default binding is F6.
+ * The default binding is <kbd>F6</kbd>.
*/
signals [CYCLE_CHILD_FOCUS] =
g_signal_new (I_("cycle-child-focus"),
*
* This is a [keybinding signal](class.SignalAction.html).
*
- * The default binding is Tab.
+ * The default binding is <kbd>Tab</kbd>.
*/
signals [TOGGLE_HANDLE_FOCUS] =
g_signal_new (I_("toggle-handle-focus"),
*
* This is a [keybinding signal](class.SignalAction.html).
*
- * The default binding for this signal is F8.
+ * The default binding for this signal is <kbd>F8</kbd>.
*/
signals [CYCLE_HANDLE_FOCUS] =
g_signal_new (I_("cycle-handle-focus"),
*
* This is a [keybinding signal](class.SignalAction.html).
*
- * The default binding for this signal is Return or Space.
+ * The default binding for this signal is <kbd>Return</kbd> or
+ * <kbd>Space</kbd>.
*/
signals [ACCEPT_POSITION] =
g_signal_new (I_("accept-position"),
*
* This is a [keybinding signal](class.SignalAction.html).
*
- * The default binding for this signal is Escape.
+ * The default binding for this signal is <kbd>Escape</kbd>.
*/
signals [CANCEL_POSITION] =
g_signal_new (I_("cancel-position"),
*
* Creates a new `GtkPaned` widget.
*
- * Returns: a new `GtkPaned`.
+ * Returns: the newly created paned widget
*/
GtkWidget *
gtk_paned_new (GtkOrientation orientation)
*
* Retrieves the start child of the given `GtkPaned`.
*
- * See also: `GtkPaned`:start-child
- *
* Returns: (transfer none) (nullable): the start child widget
*/
GtkWidget *
/**
* gtk_paned_set_resize_start_child: (attributes org.gtk.Method.set_property=resize-start-child)
* @paned: a `GtkPaned`
- * @resize: %TRUE to let the start child be resized
+ * @resize: true to let the start child be resized
*
- * Sets the `GtkPaned`:resize-start-child property
+ * Sets whether the [property@Gtk.Paned:start-child] can be resized.
*/
void
gtk_paned_set_resize_start_child (GtkPaned *paned,
* gtk_paned_get_resize_start_child: (attributes org.gtk.Method.get_property=resize-start-child)
* @paned: a `GtkPaned`
*
- * Returns whether the start child can be resized.
+ * Returns whether the [property@Gtk.Paned:start-child] can be resized.
*
- * Returns: %TRUE if the start child is resizable
+ * Returns: true if the start child is resizable
*/
gboolean
gtk_paned_get_resize_start_child (GtkPaned *paned)
/**
* gtk_paned_set_shrink_start_child: (attributes org.gtk.Method.set_property=shrink-start-child)
* @paned: a `GtkPaned`
- * @resize: %TRUE to let the start child be shrunk
+ * @resize: true to let the start child be shrunk
*
- * Sets the `GtkPaned`:shrink-start-child property
+ * Sets whether the [property@Gtk.Paned:start-child] can shrink.
*/
void
gtk_paned_set_shrink_start_child (GtkPaned *paned,
* gtk_paned_get_shrink_start_child: (attributes org.gtk.Method.get_property=shrink-start-child)
* @paned: a `GtkPaned`
*
- * Returns whether the start child can be shrunk.
+ * Returns whether the [property@Gtk.Paned:start-child] can shrink.
*
- * Returns: %TRUE if the start child is shrinkable
+ * Returns: true if the start child is shrinkable
*/
gboolean
gtk_paned_get_shrink_start_child (GtkPaned *paned)
*
* Retrieves the end child of the given `GtkPaned`.
*
- * See also: `GtkPaned`:end-child
- *
* Returns: (transfer none) (nullable): the end child widget
*/
GtkWidget *
/**
* gtk_paned_set_resize_end_child: (attributes org.gtk.Method.set_property=resize-end-child)
* @paned: a `GtkPaned`
- * @resize: %TRUE to let the end child be resized
+ * @resize: true to let the end child be resized
*
- * Sets the `GtkPaned`:resize-end-child property
+ * Sets whether the [property@Gtk.Paned:end-child] can be resized.
*/
void
gtk_paned_set_resize_end_child (GtkPaned *paned,
* gtk_paned_get_resize_end_child: (attributes org.gtk.Method.get_property=resize-end-child)
* @paned: a `GtkPaned`
*
- * Returns whether the end child can be resized.
+ * Returns whether the [property@Gtk.Paned:end-child] can be resized.
*
- * Returns: %TRUE if the end child is resizable
+ * Returns: true if the end child is resizable
*/
gboolean
gtk_paned_get_resize_end_child (GtkPaned *paned)
/**
* gtk_paned_set_shrink_end_child: (attributes org.gtk.Method.set_property=shrink-end-child)
* @paned: a `GtkPaned`
- * @resize: %TRUE to let the end child be shrunk
+ * @resize: true to let the end child be shrunk
*
- * Sets the `GtkPaned`:shrink-end-child property
+ * Sets whether the [property@Gtk.Paned:end-child] can shrink.
*/
void
gtk_paned_set_shrink_end_child (GtkPaned *paned,
* gtk_paned_get_shrink_end_child: (attributes org.gtk.Method.get_property=shrink-end-child)
* @paned: a `GtkPaned`
*
- * Returns whether the end child can be shrunk.
+ * Returns whether the [property@Gtk.Paned:end-child] can shrink.
*
- * Returns: %TRUE if the end child is shrinkable
+ * Returns: true if the end child is shrinkable
*/
gboolean
gtk_paned_get_shrink_end_child (GtkPaned *paned)
*
* Obtains the position of the divider between the two panes.
*
- * Returns: position of the divider
+ * Returns: the position of the divider, in pixels
**/
int
gtk_paned_get_position (GtkPaned *paned)
* is unset
*
* Sets the position of the divider between the two panes.
- **/
+ */
void
gtk_paned_set_position (GtkPaned *paned,
int position)
projects / gtk4.git / commitdiff