檢視原始碼 wxGauge (wx v2.4.3)

進度條是一個水平或垂直的長條，用來顯示數量（通常是時間）。

wxGauge 支援兩種工作模式：確定進度和不確定進度。

第一種是常用的工作模式（請參閱 setValue/2 和 setRange/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

摘要

類型

wxGauge()

函式

create(This, Parent, Id, Range)

等同於 create(This, Parent, Id, Range, [])。

create/5

建立進度條，用於兩步驟建構。

destroy(This)

銷毀物件

getRange(This)

傳回進度條的最大位置。

getValue(This)

傳回進度條的目前位置。

isVertical(This)

如果進度條是垂直的（具有 wxGA_VERTICAL 樣式），則傳回 true，否則傳回 false。

new()

預設建構子。

new(Parent, Id, Range)

等同於 new(Parent, Id, Range, [])。

new/4

建構子，建立並顯示進度條。

pulse(This)

將進度條切換到不確定模式（如果需要），並使進度條移動一點，以向使用者指示已取得進展。

setRange(This, Range)

設定進度條的範圍（最大值）。

setValue(This, Pos)

設定進度條的位置。

類型

wxGauge()

-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, [])。

create/5

-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 以了解更多詳細資訊。

destroy(This)

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

銷毀物件

getRange(This)

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

傳回進度條的最大位置。

請參閱： setRange/2

getValue(This)

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

傳回進度條的目前位置。

請參閱： setValue/2

isVertical(This)

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

如果進度條是垂直的（具有 wxGA_VERTICAL 樣式），則傳回 true，否則傳回 false。

new()

-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, [])。

new/4

-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

pulse(This)

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

將進度條切換到不確定模式（如果需要），並使進度條移動一點，以向使用者指示已取得進展。

注意：呼叫此函式後，getValue/1 傳回的值未定義，因此如果您想還原確定模式，則需要明確呼叫 setValue/2。

setRange(This, Range)

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

設定進度條的範圍（最大值）。

此函式會使進度條切換到確定模式（如果尚未處於此模式）。

當進度條處於不確定模式時，在 wxMSW 下，進度條會重複從零到 range 再返回；在其他埠下，當處於不確定模式時，range 設定會被忽略。

請參閱： getRange/1

setValue(This, Pos)

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

設定進度條的位置。

pos 必須介於 0 和進度條範圍之間，如 getRange/1 所傳回的，包含邊界值。

此函式會使進度條切換到確定模式（如果之前處於不確定模式）。

請參閱： getValue/1