查看源代码 wxGauge (wx v2.4.3)

进度条是一个水平或垂直的条形,用于显示数量(通常是时间)。

wxGauge 支持两种工作模式:确定性进度和不确定性进度。

第一种是通常的工作模式(参见 setValue/2setRange/2),而第二种可以在程序正在进行某些处理但您不知道完成多少进度时使用。在这种情况下,您可以定期调用 pulse/1 函数使进度条切换到不确定模式(图形上通常是在条形控件中移动或弹跳的一组块)。

wxGauge 支持在这两种工作模式之间动态切换。

进度条没有用户命令。

样式

此类支持以下样式

  • wxGA_HORIZONTAL: 创建一个水平进度条。

  • wxGA_VERTICAL: 创建一个垂直进度条。

  • wxGA_SMOOTH: 创建具有一个像素宽度更新步骤的平滑进度条(并非所有平台都支持)。

  • wxGA_TEXT: 在进度条本身中以百分比显示当前值。此样式仅在 wxQt 中受支持,在其他平台下会被忽略。此标志仅在 wxWidgets 3.1.0 及更高版本中可用。

  • wxGA_PROGRESS: 在 Windows 7 及更高版本下的应用程序任务栏按钮以及 macOS 下的 Dock 图标中反映进度条的值,在其他平台下会被忽略。此标志仅在 wxWidgets 3.1.0 及更高版本中可用。

参见

此类派生自以下类,并可以使用其函数:

wxWidgets 文档:wxGauge

摘要

函数

创建用于两步构造的进度条。

销毁对象

返回进度条的最大位置。

返回进度条的当前位置。

如果进度条是垂直的(具有 wxGA_VERTICAL 样式),则返回 true,否则返回 false。

默认构造函数。

构造函数,创建并显示进度条。

将进度条切换到不确定模式(如果需要),并使进度条移动一点,以向用户指示已取得一些进展。

设置进度条的范围(最大值)。

设置进度条的位置。

类型

-type wxGauge() :: wx:wx_object().

函数

此函数的链接

create(This, Parent, Id, Range)

查看源代码
-spec create(This, Parent, Id, Range) -> boolean()
                when
                    This :: wxGauge(),
                    Parent :: wxWindow:wxWindow(),
                    Id :: integer(),
                    Range :: integer().

等效于 create(This, Parent, Id, Range, [])

-spec create(This, Parent, Id, Range, [Option]) -> boolean()
                when
                    This :: wxGauge(),
                    Parent :: wxWindow:wxWindow(),
                    Id :: integer(),
                    Range :: integer(),
                    Option ::
                        {pos, {X :: integer(), Y :: integer()}} |
                        {size, {W :: integer(), H :: integer()}} |
                        {style, integer()} |
                        {validator, wx:wx_object()}.

创建用于两步构造的进度条。

有关更多详细信息,请参见 new/4

-spec destroy(This :: wxGauge()) -> ok.

销毁对象

-spec getRange(This) -> integer() when This :: wxGauge().

返回进度条的最大位置。

参见:setRange/2

-spec getValue(This) -> integer() when This :: wxGauge().

返回进度条的当前位置。

参见:setValue/2

-spec isVertical(This) -> boolean() when This :: wxGauge().

如果进度条是垂直的(具有 wxGA_VERTICAL 样式),则返回 true,否则返回 false。

-spec new() -> wxGauge().

默认构造函数。

此函数的链接

new(Parent, Id, Range)

查看源代码
-spec new(Parent, Id, Range) -> wxGauge()
             when Parent :: wxWindow:wxWindow(), Id :: integer(), Range :: integer().

等效于 new(Parent, Id, Range, [])

-spec new(Parent, Id, Range, [Option]) -> wxGauge()
             when
                 Parent :: wxWindow:wxWindow(),
                 Id :: integer(),
                 Range :: integer(),
                 Option ::
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()} |
                     {validator, wx:wx_object()}.

构造函数,创建并显示进度条。

参见:create/5

-spec pulse(This) -> ok when This :: wxGauge().

将进度条切换到不确定模式(如果需要),并使进度条移动一点,以向用户指示已取得一些进展。

注意:调用此函数后,getValue/1 返回的值未定义,因此如果要恢复确定性模式,则需要显式调用 setValue/2

-spec setRange(This, Range) -> ok when This :: wxGauge(), Range :: integer().

设置进度条的范围(最大值)。

此函数使进度条切换到确定性模式,如果它尚未处于该模式。

当进度条处于不确定模式时,在 wxMSW 下,进度条会反复从零到 range 再返回;在其他端口下,当处于不确定模式时,range 设置将被忽略。

参见:getRange/1

-spec setValue(This, Pos) -> ok when This :: wxGauge(), Pos :: integer().

设置进度条的位置。

pos 必须介于 0 和进度条范围之间,由 getRange/1 返回,包括边界值。

此函数使进度条切换到确定性模式,如果它之前处于不确定模式。

参见:getValue/1