GtkProgressBar             package:RGtk2             R Documentation

_G_t_k_P_r_o_g_r_e_s_s_B_a_r

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

     A widget which indicates progress visually

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

     'gtkProgressBarNew(show = TRUE)'
      'gtkProgressBarPulse(object)'
      'gtkProgressBarSetText(object, text)'
      'gtkProgressBarSetFraction(object, fraction)'
      'gtkProgressBarSetPulseStep(object, fraction)'
      'gtkProgressBarSetOrientation(object, orientation)'
      'gtkProgressBarSetEllipsize(object, mode)'
      'gtkProgressBarGetText(object)'
      'gtkProgressBarGetFraction(object)'
      'gtkProgressBarGetPulseStep(object)'
      'gtkProgressBarGetOrientation(object)'
      'gtkProgressBarGetEllipsize(object)'
      'gtkProgressBarNewWithAdjustment(adjustment = NULL, show = TRUE)'
      'gtkProgressBarSetBarStyle(object, style)'
      'gtkProgressBarSetDiscreteBlocks(object, blocks)'
      'gtkProgressBarSetActivityStep(object, step)'
      'gtkProgressBarSetActivityBlocks(object, blocks)'
      'gtkProgressBarUpdate(object, percentage)'
      'gtkProgressBar(adjustment = NULL, show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkProgress
                                +----GtkProgressBar 

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

     GtkProgressBar implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkProgressBar' is typically used to display the progress of
     a long running operation.  It provides a visual clue that
     processing is underway.  The 'GtkProgressBar' can be used in two
     different modes: percentage mode and activity mode.

     When an application can determine how much work needs to take
     place  (e.g. read a fixed number of bytes from a file) and can
     monitor its progress, it can use the 'GtkProgressBar' in
     percentage mode and the user sees a growing bar indicating the
     percentage of the work that has been completed.  In this mode, the
     application is required to call 'gtkProgressBarSetFraction'
     periodically to update the progress bar.

     When an application has no accurate way of knowing the amount of
     work to do, it can use the 'GtkProgressBar' in activity mode,
     which shows activity  by a block moving back and forth within the
     progress area. In this mode, the application is required to call
     'gtkProgressBarPulse' perodically to update the progress bar.

     There is quite a bit of flexibility provided to control the
     appearance of the 'GtkProgressBar'.  Functions are provided to
     control the  orientation of the bar, optional text can be
     displayed along with the bar, and the step size used in activity
     mode can be set. *PLEASE NOTE:* The 'GtkProgressBar'/'GtkProgress'
     API in GTK 1.2 was bloated, needlessly complex and hard to use
     properly.  Therefore 'GtkProgress' has been deprecated completely
     and the 'GtkProgressBar' API has been reduced to the following 10
     functions: 'gtkProgressBarNew', 'gtkProgressBarPulse', 
     'gtkProgressBarSetText', 'gtkProgressBarSetFraction', 
     'gtkProgressBarSetPulseStep', 'gtkProgressBarSetOrientation', 
     'gtkProgressBarGetText', 'gtkProgressBarGetFraction', 
     'gtkProgressBarGetPulseStep', 'gtkProgressBarGetOrientation'. 
     These have been grouped at the beginning of this section, followed
     by  a large chunk of deprecated 1.2 compatibility functions.

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


     '_G_t_k_P_r_o_g_r_e_s_s_B_a_r' The 'GtkProgressBar' struct contains private data
          only,  and should be accessed using the functions below.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkProgressBar' is the result of collapsing the constructors of
     'GtkProgressBar' ('gtkProgressBarNew',
     'gtkProgressBarNewWithAdjustment') and accepts a subset of its
     arguments matching the required arguments of one of its delegate
     constructors.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_P_r_o_g_r_e_s_s_B_a_r_O_r_i_e_n_t_a_t_i_o_n' An enumeration representing possible
          orientations and growth directions for the visible progress
          bar.

          '_l_e_f_t-_t_o-_r_i_g_h_t' A horizontal progress bar growing from left
               to right.

          '_r_i_g_h_t-_t_o-_l_e_f_t' A horizontal progress bar growing from right
               to left.

          '_b_o_t_t_o_m-_t_o-_t_o_p' A vertical progress bar growing from bottom
               to top.

          '_t_o_p-_t_o-_b_o_t_t_o_m' A vertical progress bar growing from top to
               bottom.


     '_G_t_k_P_r_o_g_r_e_s_s_B_a_r_S_t_y_l_e' An enumeration representing the styles for
          drawing the progress bar.

          '_c_o_n_t_i_n_u_o_u_s' The progress bar grows in a smooth, continuous
               manner.

          '_d_i_s_c_r_e_t_e' The progress bar grows in discrete, visible
               blocks.


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


     '_a_c_t_i_v_i_t_y-_b_l_o_c_k_s' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The number of blocks
          which can fit in the progress bar area in activity mode
          (Deprecated).  Allowed values: >= 2  Default value: 5


     '_a_c_t_i_v_i_t_y-_s_t_e_p' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The increment used for
          each iteration in activity mode (Deprecated).  Default value:
          3


     '_a_d_j_u_s_t_m_e_n_t' ['_G_t_k_A_d_j_u_s_t_m_e_n_t' : _R_e_a_d / _W_r_i_t_e] The GtkAdjustment
          connected to the progress bar (Deprecated).


     '_b_a_r-_s_t_y_l_e' ['_G_t_k_P_r_o_g_r_e_s_s_B_a_r_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] Specifies the
          visual style of the bar in percentage mode (Deprecated). 
          Default value: GTK_PROGRESS_CONTINUOUS


     '_d_i_s_c_r_e_t_e-_b_l_o_c_k_s' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The number of discrete
          blocks in a progress bar (when shown in the discrete style). 
          Allowed values: >= 2  Default value: 10


     '_e_l_l_i_p_s_i_z_e' ['_P_a_n_g_o_E_l_l_i_p_s_i_z_e_M_o_d_e' : _R_e_a_d / _W_r_i_t_e] The preferred
          place to ellipsize the string, if the progressbar does  not
          have enough room to display the entire string, specified as a
           'PangoEllisizeMode'. 

          Note that setting this property to a value other than 
          'PANGO_ELLIPSIZE_NONE' has the side-effect that the
          progressbar requests  only enough space to display the
          ellipsis "...". Another means to set a  progressbar's width
          is 'gtkWidgetSetSizeRequest'.  

          Default value: PANGO_ELLIPSIZE_NONE  Since  2.6


     '_f_r_a_c_t_i_o_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The fraction of total work
          that has been completed.  Allowed values: [0,1]  Default
          value: 0


     '_o_r_i_e_n_t_a_t_i_o_n' ['_G_t_k_P_r_o_g_r_e_s_s_B_a_r_O_r_i_e_n_t_a_t_i_o_n' : _R_e_a_d / _W_r_i_t_e] 
          Orientation and growth direction of the progress bar. 
          Default value: GTK_PROGRESS_LEFT_TO_RIGHT


     '_p_u_l_s_e-_s_t_e_p' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The fraction of total
          progress to move the bouncing block when pulsed.  Allowed
          values: [0,1]  Default value: 0.1


     '_t_e_x_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Text to be displayed in the
          progress bar.  Default value: "%P %%"


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


     '_x_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Extra spacing applied to the
          width of a progress bar.  Allowed values: >= 0  Default
          value: 7


     '_y_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Extra spacing applied to the
          height of a progress bar.  Allowed values: >= 0  Default
          value: 7


_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/GtkProgressBar.html>

