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>\r
   9 The primary purpose of this class is to keep track of the various properties\r
  10 of #GtkHButtonBox and #GtkVButtonBox widgets.\r
  11 </para>\r
  12 <para>\r
  13 gtk_button_box_get_child_size_default() retrieves the default minimum width and height \r
  14 for widgets in any button box. gtk_button_box_set_child_size_default()\r
  15 changes the default minimum child widget size.\r
  16 </para>\r
  17 <para>\r
  18 gtk_button_box_get_child_size() retrieves the minimum width and height \r
  19 for widgets in a given button box. gtk_button_box_set_child_size() \r
  20 allows those properties to be changed.\r
  21 </para>\r
  22 <para>\r
  23 gtk_button_box_get_child_ipadding_default() gets the default number of pixels of \r
  24 horizontal and vertical padding that are applied to each button in every button box.\r
  25 gtk_button_box_set_child_ipadding_default() allows these defaults to be\r
  26 changed.\r
  27 </para>\r
  28 <para>\r
  29 The internal padding of buttons can be retrieved and changed per button box using\r
  30 gtk_button_box_get_child_ipadding() and gtk_button_box_set_child_ipadding()\r
  31 respectively.\r
  32 </para>\r
  33 <para>\r
  34 gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and\r
  35 change default number of pixels between buttons, respectively.\r
  36 </para>\r
  37 <para>\r
  38 gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and alter the method\r
  39 used to spread the buttons in a button box across the container, respectively.\r
  40 </para>\r
  41 \r
  42 <para>\r
  43 \r
  44 </para>
  45
  46 <!-- ##### SECTION See_Also ##### -->
  47 <para>\r
  48 <variablelist>\r
  49 <varlistentry>\r
  50 <term>#GtkVButtonBox</term>\r
  51 <listitem><para>Vertical sub-class of #GtkButtonBox.</para></listitem>\r
  52 </varlistentry>\r
  53 <varlistentry>\r
  54 <term>#GtkHButtonBox</term>\r
  55 <listitem><para>Horizontal sub-class of #GtkButtonBox.</para></listitem>\r
  56 </varlistentry>\r
  57 </variablelist>\r
  58 </para>
  59
  60 <!-- ##### STRUCT GtkButtonBox ##### -->
  61 <para>\r
  62 This is a read-only struct; no members should be modified directly.\r
  63 </para>
  64
  65
  66 <!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
  67 <para>\r
  68 Used internally only.\r
  69 </para>
  70
  71
  72
  73 <!-- ##### MACRO gtk_button_box_get_spacing ##### -->
  74 <para>\r
  75 Retrieves how much space a button box is placing between each child button.\r
  76 </para>
  77
  78 @Returns: the current spacing applied to the buttons in @widget.
  79 <!-- # Unused Parameters # -->
  80 @widget: a #GtkButtonBox.
  81
  82
  83 <!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
  84 <para>\r
  85 Retrieves the method being used to arrange the buttons in a button box.\r
  86 </para>
  87
  88 @widget: a #GtkButtonBox.
  89 @Returns: the method used to layout buttons in @widget.
  90
  91
  92 <!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
  93 <para>\r
  94 Retrieves the current width and height of all child widgets in a button box.\r
  95 @min_width and @min_height are filled with those values, respectively.\r
  96 </para>
  97
  98 @widget: a #GtkButtonBox.
  99 @min_width: the width of the buttons contained by @widget.
 100 @min_height: the height of the buttons contained by @widget.
 101
 102
 103 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
 104 <para>\r
 105 Gets the default number of pixels that pad the buttons in a given button box.\r
 106 </para>
 107
 108 @widget: a #GtkButtonBox.
 109 @ipad_x: the horizontal padding used by buttons in @widget.
 110 @ipad_y: the vertical padding used by buttons in @widget.
 111
 112
 113 <!-- ##### MACRO gtk_button_box_set_spacing ##### -->
 114 <para>\r
 115 Sets the amount of spacing between buttons in a given button box.\r
 116 </para>
 117
 118 <!-- # Unused Parameters # -->
 119 @widget: a #GtkButtonBox.
 120 @spacing: the number of pixels of spacing.
 121
 122
 123 <!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
 124 <para>\r
 125 Changes the way buttons are arranged in their container.\r
 126 </para>
 127
 128 @widget: a #GtkButtonBox.
 129 @layout_style: the new layout style.
 130
 131
 132 <!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
 133 <para>\r
 134 Sets a new default size for the children of a given button box.\r
 135 </para>
 136
 137 @widget: a #GtkButtonBox.
 138 @min_width: a default width for buttons in @widget.
 139 @min_height: a default height for buttons in @widget.
 140
 141
 142 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
 143 <para>\r
 144 Changes the amount of internal padding used by all buttons in a given button\r
 145 box.\r
 146 </para>
 147
 148 @widget: a #GtkButtonBox.
 149 @ipad_x: the horizontal padding that should be used by each button in @widget.
 150 @ipad_y: the vertical padding that should be used by each button in @widget.
 151
 152