GtkScale                package:RGtk2                R Documentation

_G_t_k_S_c_a_l_e

_D_e_s_c_r_i_p_t_i_o_n:

     Base class for GtkHScale and GtkVScale

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkScaleSetDigits(object, digits)'
      'gtkScaleSetDrawValue(object, draw.value)'
      'gtkScaleSetValuePos(object, pos)'
      'gtkScaleGetDigits(object)'
      'gtkScaleGetDrawValue(object)'
      'gtkScaleGetValuePos(object)'
      'gtkScaleGetLayout(object)'
      'gtkScaleGetLayoutOffsets(object)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkRange
                                +----GtkScale
                                      +----GtkHScale
                                      +----GtkVScale 

_I_n_t_e_r_f_a_c_e_s:

     GtkScale implements AtkImplementorIface and  'GtkBuildable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     A 'GtkScale' is a slider control used to select a numeric value.
     To use it, you'll probably want to investigate the methods on  its
     base class, 'GtkRange', in addition to the methods for 'GtkScale'
     itself. To set the value of a scale, you would normally use
     'gtkRangeSetValue'.  To detect changes to the value, you would
     normally use the "value_changed"  signal.

     The 'GtkScale' widget is an abstract class, used only for deriving
     the subclasses 'GtkHScale' and 'GtkVScale'. To create a scale
     widget,  call 'gtkHScaleNewWithRange' or 'gtkVScaleNewWithRange'.

_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_S_c_a_l_e' The 'GtkScale' struct contains the following fields.
          (These fields should be considered read-only. They should
          never be set by an application.)

            'numeric'  'draw_value'  ;  non-zero if the scale's current value is displayed next to the slider.
            'numeric'  'value_pos'  ;   the position in which the textual value is displayed, selected from 'GtkPositionType'  .


_S_i_g_n_a_l_s:


     '_f_o_r_m_a_t-_v_a_l_u_e(_s_c_a_l_e, _a_r_g_1, _u_s_e_r._d_a_t_a)' Signal which allows you to
          change how the scale value is displayed.  Connect a signal
          handler which returns an allocated string representing
          'value'. That string will then be used to display the scale's
          value. Here's an example signal handler which displays a
          value 1.0 as with "->1.0<-".


          format_value_callback <- function(scale, value)
          {
            return(paste("-->", format(value,
          nsmall=scale$getDigits()), "<--"), sep="")
          }

          '_s_c_a_l_e' ['GtkScale'] the object which received the signal.

          '_a_r_g_1' [numeric] 

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.

          _Returns:_ [character] allocated string representing 'value'


_P_r_o_p_e_r_t_i_e_s:


     '_d_i_g_i_t_s' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The number of decimal places
          that are displayed in the value.  Allowed values: [-1,64] 
          Default value: 1


     '_d_r_a_w-_v_a_l_u_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the current value is
          displayed as a string next to the slider.  Default value:
          TRUE


     '_v_a_l_u_e-_p_o_s' ['_G_t_k_P_o_s_i_t_i_o_n_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] The position in
          which the current value is displayed.  Default value:
          GTK_POS_TOP


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_s_l_i_d_e_r-_l_e_n_g_t_h' [_i_n_t_e_g_e_r : _R_e_a_d] Length of scale's slider. 
          Allowed values: >= 0  Default value: 31


     '_v_a_l_u_e-_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Space between value text and the
          slider/trough area.  Allowed values: >= 0  Default value: 2


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/gtk/GtkScale.html>

