进度条 Progress Bars

进度条用于显示正在进行的操作的状态。在下面的代码中可以看出,它相当容易使用。

创建进度条

下面的内容从创建一个新进度条开始。

GtkWidget *gtk_progress_bar_new( void );

设置进度条的值

创建进度条后就可以使用它了。

void gtk_progress_bar_set_fraction ( GtkProgressBar *pbar,
                                     gdouble        fraction );

参数:

  • pbar
    该参数是希望操作的进度条;
  • fraction
    该参数是“已完成”的百分比,意思是进度条从0-100%已经填充的数量;
    该参数值的范围为[0,1];

单词:

  • fraction 英[ˈfrækʃn]
    n. [数]分数; 一小部分,些微; 不相连的一块,片段; [化]分馏

GTK 1.2版已经给进度条添加了一个新的功能,那就是允许它以不同的方法显示其值,并通知用户它的当前值和范围。

设置进度条的移动方向

进度条可以用以下函数设置它的移动方向:

void gtk_progress_bar_set_orientation( GtkProgressBar *pbar,
                                       GtkProgressBarOrientation orientation );

orientation参数可以取下列值之一,以指示进度条的移动方向:

  GTK_PROGRESS_LEFT_TO_RIGHT  从左向右
  GTK_PROGRESS_RIGHT_TO_LEFT  从右向左
  GTK_PROGRESS_BOTTOM_TO_TOP  从下向上
  GTK_PROGRESS_TOP_TO_BOTTOM  从上向下

设置进度条向前移动一下

如果我们不像每次都通过 gtk_progress_bar_set_fraction() 给进度条设置一个向前移动的累计值,那么我们可以使用下面的2个函数来完成:先通过 gtk_progress_bar_set_pulse_step()设置一个每次向前移动的步进值,然后再通过gtk_progress_bar_pulse()告诉进度条按照刚才设置的步进值直接向前移动。

除了上面指示进度已经发生的数量以外,进度条还可以设置为仅仅指示有活动在继续,即活动状态。这在进度无法按数值度量的情况下很有用。

用下面的函数来表明进度有了些进展。

//设置进度条向前移动一点(每次移动的步进值是由gtk_progress_bar_set_pulse_step()设置好的)
void gtk_progress_bar_pulse ( GtkProgressBar *progress );

进度条每次移动的步进值由以下函数设置:

void gtk_progress_bar_set_pulse_step( GtkProgressBar *pbar,
                                      gdouble         fraction );

在进度条中间设置一个字符串

在非活动状态下,进度条可以用下列函数在滑槽里显示一个可配置的字符串:

void gtk_progress_bar_set_text( GtkProgressBar *progress,
                                const gchar    *text );

参数:

  • text
    你可以通过调用 gtk_progess_bar_set_text() 并把 NULL 作为该参数来关闭文本串的显示.

注意:
gtk_progress_set_text()不再支持 GTK+ 1.2版进度条里那种类似printf()的格式参数

获取进度条的值

进度条的当前文本设置能由下面的函数取得。不要释放返回的字符串.

const gchar *gtk_progress_bar_get_text( GtkProgressBar *pbar );

进度条通常和timeouts或其它类似函数同时使用(详见超时、I/O 和 Idle 函数这一章),使应用程序就像是多任务一样。一般都以同样的方式调用 gtk_progress_bar_set_fraction() 或 gtk_progress_bar_pulse() 函数。

示例

下面是一个进度条的示例,用timeout函数更新进度条的值。代码也演示了怎样复位进度条。

进度条 - 图1

#include <gtk/gtk.h>

//定义一个进度条的结构体类型 ProgressData :
typedef struct _ProgressData {
  GtkWidget *window;
  GtkWidget *pbar;
  int timer;
  gboolean activity_mode;
} ProgressData;

//定时器:
/* 定时更新进度条,这样就能够看到进度条的移动 */
gint progress_timeout( gpointer data )
{
    ProgressData *pdata = (ProgressData *)data;
    gdouble new_val;

    //如果在界面勾选了 "Activity mode"复选框:
    if (pdata->activity_mode)
    {
        //设置进度条向前移动一点(每次移动的步进值是由gtk_progress_bar_set_pulse_step()设置好的)。
        gtk_progress_bar_pulse (GTK_PROGRESS_BAR (pdata->pbar));
    }
    //如果在界面没有勾选 "Activity mode"复选框:
    else
    {
        /* 先获取一下当前进度条的值,然后让其值+0.01 */
        new_val = gtk_progress_bar_get_fraction (GTK_PROGRESS_BAR (pdata->pbar)) + 0.01;
        //如果新设置的值>1,则再从0开始:
        if (new_val > 1.0)
        {
            new_val = 0.0;
        }
        /* 把上面计算的新值设置给进度条: */
        gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (pdata->pbar), new_val);
    }

    /* 这是一个timeout函数,返回 TRUE,这样它就能够继续被调用 */
    return TRUE;
} 

//对应界面上 ShowText复选框控件绑定的回调函数:
/* 回调函数,切换在进度条你的滑槽上的文本显示 */
void toggle_show_text( GtkWidget    *widget,
                           ProgressData *pdata )
{
    const gchar *text;

    //获取传递过来的pdata中pbar成员记录的进度条的值:
    text = gtk_progress_bar_get_text (GTK_PROGRESS_BAR (pdata->pbar));
    //如果该进度条上已经有值了,则设置为空:
    if (text && *text)
    {
        gtk_progress_bar_set_text (GTK_PROGRESS_BAR (pdata->pbar), "");
    }
    //如果该进度条上还没有值,则设置一个值: The ShowText checkbox has been checked.
    else 
    {
        gtk_progress_bar_set_text (GTK_PROGRESS_BAR (pdata->pbar), "The ShowText checkbox has been checked.");
    }
}

//对应界面上 Activity mode复选框控件绑定的回调函数:
/* 回调函数,切换进度条的活动模式 */
void toggle_activity_mode( GtkWidget    *widget,
                               ProgressData *pdata )
{
    //将pdata->activity_mode 已经记录的当前的 Activity mode复选框控件的值取反。
    pdata->activity_mode = !pdata->activity_mode;

    //如果当前已经勾选了 Activity mode复选框控件:
    if (pdata->activity_mode)
    {
        //设置进度条从左到右进行滑动更新:
        gtk_progress_bar_pulse (GTK_PROGRESS_BAR (pdata->pbar));
    }
    //如果当前没有勾选了 Activity mode复选框控件:
    else
    {
        //设置进度条按照从左到右、再从右到左来回滑动更新:
        gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (pdata->pbar), 0.0);
    }
}

//对应界面上 Right to Left复选框控件绑定的回调函数: 
/* 回调函数,切换进度条的移动方向 */
void toggle_orientation( GtkWidget    *widget,
                            ProgressData *pdata )
{
    //gtk_progress_bar_get_orientation (GTK_PROGRESS_BAR (pdata->pbar)) 用于获取当前 pdata->pbar 记录的进度条的移动方向
    switch (gtk_progress_bar_get_orientation (GTK_PROGRESS_BAR (pdata->pbar)))
    {    
        //如果当前进度条的移动方向是从左到右,则设置为从右到左:
        case GTK_PROGRESS_LEFT_TO_RIGHT:
            gtk_progress_bar_set_orientation (GTK_PROGRESS_BAR (pdata->pbar), 
                                                GTK_PROGRESS_RIGHT_TO_LEFT);
        break;
        //如果当前进度条的移动方向是从右到左,则设置为从左到右:
        case GTK_PROGRESS_RIGHT_TO_LEFT:
            gtk_progress_bar_set_orientation (GTK_PROGRESS_BAR (pdata->pbar), 
                                                GTK_PROGRESS_LEFT_TO_RIGHT);
        break;
        default:
            // 什么也不做
        break;
    }
}


/* 清除分配的内存,删除定时器(timer) */
void destroy_progress( GtkWidget     *widget,
               ProgressData *pdata)
{
    gtk_timeout_remove (pdata->timer);
    pdata->timer = 0;
    pdata->window = NULL;
    g_free (pdata);
    gtk_main_quit ();
}

int main( int   argc,
          char *argv[])
{
    ProgressData *pdata;
    GtkWidget *align;
    GtkWidget *separator;
    GtkWidget *table;
    GtkWidget *button;
    GtkWidget *check;
    GtkWidget *vbox;

    gtk_init (&argc, &argv);

    /* 为传递到回调函数中的数据分配内存 */
    pdata = g_malloc (sizeof (ProgressData));

    //将新创建的窗口句柄记录到结构体变量指针pdata中:
    pdata->window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
    gtk_window_set_resizable (GTK_WINDOW (pdata->window), TRUE);
    g_signal_connect (G_OBJECT (pdata->window), "destroy",
                        G_CALLBACK (destroy_progress),
                        pdata);
    gtk_window_set_title (GTK_WINDOW (pdata->window), "www.softool.cn - Progress Bar");
    gtk_container_set_border_width (GTK_CONTAINER (pdata->window), 0);

    //创建垂直方向排列控件的box:
    //5 - 相当于对应5行
    vbox = gtk_vbox_new (FALSE, 5);
    gtk_container_set_border_width (GTK_CONTAINER (vbox), 10);
    gtk_container_add (GTK_CONTAINER (pdata->window), vbox);
    gtk_widget_show (vbox);

    /* 创建一个居中对齐的对象 */
    align = gtk_alignment_new (0.5, 0.5, 0, 0);
    //设置vbox容器中的控件按照上一句align进行居中对齐:
    gtk_box_pack_start (GTK_BOX (vbox), align, FALSE, FALSE, 5);
    gtk_widget_show (align);

    /* 创建一个进度条,并把该句柄记录到结构体变量指针pdata中: */
    pdata->pbar = gtk_progress_bar_new ();
    //设置该进度条居中对齐:gtk_progress_bar_pulse
    gtk_container_add (GTK_CONTAINER (align), pdata->pbar);
    gtk_widget_show (pdata->pbar);

    /* 添加一个定时器(timer),在示例中以便模拟动态更新进度条的值: */
    //设置该定时器间隔时间为100ms,对应的处理函数为 progress_timeout(),传递的参数为 pdata
    pdata->timer = gtk_timeout_add (100, progress_timeout, pdata);

    //创建一个水平方向的分隔符:
    separator = gtk_hseparator_new ();
    //将该分隔符添加到上面创建的box容器中:
    gtk_box_pack_start (GTK_BOX (vbox), separator, FALSE, FALSE, 0);
    gtk_widget_show (separator);

    //创建一个2*2的table控件:
    /* 行数、列数、同质性(homogeneous) */
    table = gtk_table_new (2, 2, FALSE);
    //把该table添加到上面创建的box中:
    gtk_box_pack_start (GTK_BOX (vbox), table, FALSE, TRUE, 0);
    gtk_widget_show (table);

    /* 添加一个复选框控件,以选择是否在进度条中间显示字符串: */
    check = gtk_check_button_new_with_label ("ShowText");
    //将该复选框控件添加到table里:
    gtk_table_attach (GTK_TABLE (table), check, 0, 1, 0, 1,
                      GTK_EXPAND | GTK_FILL, GTK_EXPAND | GTK_FILL,
                        5, 5);
    //为复选框控件绑定clicked事件的回调函数为toggle_show_text(),同时传递进去的参数值为pdata指针变量
    g_signal_connect (G_OBJECT (check), "clicked",
                      G_CALLBACK (toggle_show_text),
                      pdata);
    gtk_widget_show (check);

    /* 添加一个复选框控件,切换活动状态 */
    check = gtk_check_button_new_with_label ("Activity mode");
    gtk_table_attach (GTK_TABLE (table), check, 0, 1, 1, 2,
                      GTK_EXPAND | GTK_FILL, GTK_EXPAND | GTK_FILL,
                          5, 5);
    g_signal_connect (G_OBJECT (check), "clicked",
                      G_CALLBACK (toggle_activity_mode),
                      pdata);
    gtk_widget_show (check);

    /* 添加一个复选框控件,切换移动方向为:从右到左 */
    check = gtk_check_button_new_with_label ("Right to Left");
    gtk_table_attach (GTK_TABLE (table), check, 0, 1, 2, 3,
                      GTK_EXPAND | GTK_FILL, GTK_EXPAND | GTK_FILL,
                          5, 5);
    g_signal_connect (G_OBJECT (check), "clicked",
                      G_CALLBACK (toggle_orientation),
                      pdata);
    gtk_widget_show (check);

    /* 添加一个close按钮,用来退出应用程序 */
    button = gtk_button_new_with_label ("close");
    g_signal_connect_swapped (G_OBJECT (button), "clicked",
                              G_CALLBACK (gtk_widget_destroy),
                              pdata->window);
    gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);

    /* 将按钮设置为能缺省的控件 */
    GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);

    /* 将缺省焦点设置到这个按钮上,使之成为缺省按钮,只要按回车键就相当于点击了这个按钮 */
    //译者注:能缺省的控件在获取焦点后成为缺省控件,用户按方向键等可以切换焦点。
    gtk_widget_grab_default (button);
    gtk_widget_show (button);

    gtk_widget_show (pdata->window);

    gtk_main ();

    return 0;
}