Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkbbox.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkButtonBox
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base class for #GtkHButtonBox and #GtkVButtonBox
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The primary purpose of this class is to keep track of the various properties
  10 of #GtkHButtonBox and #GtkVButtonBox widgets.
  11 </para>
  12 <para>
  13 gtk_button_box_get_child_size() retrieves the minimum width and height
  14 for widgets in a given button box. gtk_button_box_set_child_size()
  15 allows those properties to be changed.
  16 </para>
  17 <para>
  18 The internal padding of buttons can be retrieved and changed per button box using
  19 gtk_button_box_get_child_ipadding() and gtk_button_box_set_child_ipadding()
  20 respectively.
  21 </para>
  22 <para>
  23 gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and
  24 change default number of pixels between buttons, respectively.
  25 </para>
  26 <para>
  27 gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and alter the method
  28 used to spread the buttons in a button box across the container, respectively.
  29 </para>
  30
  31 <para>
  32
  33 </para>
  34
  35 <!-- ##### SECTION See_Also ##### -->
  36 <para>
  37 <variablelist>
  38 <varlistentry>
  39 <term>#GtkVButtonBox</term>
  40 <listitem><para>Vertical sub-class of #GtkButtonBox.</para></listitem>
  41 </varlistentry>
  42 <varlistentry>
  43 <term>#GtkHButtonBox</term>
  44 <listitem><para>Horizontal sub-class of #GtkButtonBox.</para></listitem>
  45 </varlistentry>
  46 </variablelist>
  47 </para>
  48
  49 <!-- ##### STRUCT GtkButtonBox ##### -->
  50 <para>
  51 This is a read-only struct; no members should be modified directly.
  52 </para>
  53
  54
  55 <!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
  56 <para>
  57 Used internally only.
  58 </para>
  59
  60
  61
  62 <!-- ##### MACRO gtk_button_box_get_spacing ##### -->
  63 <para>
  64 Retrieves how much space a button box is placing between each child button.
  65 </para>
  66
  67 @b:
  68 @Returns: the current spacing applied to the buttons in @widget.
  69 <!-- # Unused Parameters # -->
  70 @widget: a #GtkButtonBox.
  71
  72
  73 <!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
  74 <para>
  75 Retrieves the method being used to arrange the buttons in a button box.
  76 </para>
  77
  78 @widget: a #GtkButtonBox.
  79 @Returns: the method used to layout buttons in @widget.
  80
  81
  82 <!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
  83 <para>
  84 Retrieves the current width and height of all child widgets in a button box.
  85 @min_width and @min_height are filled with those values, respectively.
  86 </para>
  87
  88 @widget: a #GtkButtonBox.
  89 @min_width: the width of the buttons contained by @widget.
  90 @min_height: the height of the buttons contained by @widget.
  91 @Deprecated: Use the style properties
  92 <literal>"child-min-width/-height"</literal> instead.
  93
  94
  95 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
  96 <para>
  97 Gets the default number of pixels that pad the buttons in a given button box.
  98 </para>
  99
 100 @widget: a #GtkButtonBox.
 101 @ipad_x: the horizontal padding used by buttons in @widget.
 102 @ipad_y: the vertical padding used by buttons in @widget.
 103 @Deprecated: Use the style properties
 104 <literal>"child-internal-pad-x/-y"</literal> instead.
 105
 106
 107 <!-- ##### MACRO gtk_button_box_set_spacing ##### -->
 108 <para>
 109 Sets the amount of spacing between buttons in a given button box.
 110 </para>
 111
 112 @b:
 113 @s:
 114 <!-- # Unused Parameters # -->
 115 @widget: a #GtkButtonBox.
 116 @spacing: the number of pixels of spacing.
 117
 118
 119 <!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
 120 <para>
 121 Changes the way buttons are arranged in their container.
 122 </para>
 123
 124 @widget: a #GtkButtonBox.
 125 @layout_style: the new layout style.
 126
 127
 128 <!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
 129 <para>
 130 Sets a new default size for the children of a given button box.
 131 </para>
 132
 133 @widget: a #GtkButtonBox.
 134 @min_width: a default width for buttons in @widget.
 135 @min_height: a default height for buttons in @widget.
 136 @Deprecated: Use the style properties
 137 <literal>"child-min-width/-height"</literal> instead.
 138
 139 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
 140 <para>
 141 Changes the amount of internal padding used by all buttons in a given button
 142 box.
 143 </para>
 144
 145 @widget: a #GtkButtonBox.
 146 @ipad_x: the horizontal padding that should be used by each button in @widget.
 147 @ipad_y: the vertical padding that should be used by each button in @widget.
 148 @Deprecated: Use the style properties
 149 <literal>"child-internal-pad-x/-y"</literal> instead.
 150
 151 <!-- ##### FUNCTION gtk_button_box_set_child_secondary ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @widget:
 157 @child:
 158 @is_secondary:
 159
 160
 161 <!-- ##### ARG GtkButtonBox:layout-style ##### -->
 162 <para>
 163
 164 </para>
 165
 166 <!-- ##### ARG GtkButtonBox:secondary ##### -->
 167 <para>
 168
 169 </para>
 170
 171 <!-- ##### ARG GtkButtonBox:child-internal-pad-x ##### -->
 172 <para>
 173
 174 </para>
 175
 176 <!-- ##### ARG GtkButtonBox:child-internal-pad-y ##### -->
 177 <para>
 178
 179 </para>
 180
 181 <!-- ##### ARG GtkButtonBox:child-min-height ##### -->
 182 <para>
 183
 184 </para>
 185
 186 <!-- ##### ARG GtkButtonBox:child-min-width ##### -->
 187 <para>
 188
 189 </para>
 190