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

wxToolbook 是一個類似於 wxNotebook 的類別,但它使用 wxToolBar 來顯示標籤,而不是使用索引標籤。

目前這個類別還沒有文件,但它的用法與 wxNotebook 完全相同(除了明顯只與索引標籤相關的功能之外),所以目前請參考該類別的文件。您也可以使用 page_samples_notebook 來查看 wxToolbook 的實際運作。

這個類別有一個 wxBookCtrlBase 不支援的功能,就是可以停用某些頁面,請參閱 EnablePage()(在 wx 中尚未實作)。

樣式

這個類別支援以下樣式

  • wxTBK_BUTTONBAR: 在 macOS 下使用基於 wxButtonToolBar 的實作(在其他平台上會被忽略)。

  • wxTBK_HORZ_LAYOUT: 並排顯示文字和圖示,而不是垂直堆疊(僅在 Windows 和 GTK 2 平台下實作,因為它依賴 wxTB_HORZ_LAYOUT 旗標的支援)。概述 bookctrl 中描述的常見 wxBookCtrl 樣式也受支援。

請參閱

這個類別繼承自以下類別,並可以使用它們的函式

wxWidgets 文件:wxToolbook

事件

這個類別發出的事件類型

摘要

函式

新增一個新頁面。

在索引標籤之間循環。

設定頁面控制項的影像列表並取得該列表的所有權。

將選擇變更為指定的頁面,並傳回先前的選擇。

建立已經使用預設建構函式建構的工具書控制項。

刪除所有頁面。

銷毀物件

傳回目前選取的頁面,如果沒有則傳回 NULL。

傳回關聯的影像列表,可能為 NULL。

傳回指定頁面位置的視窗。

傳回控制項中的頁面數量。

傳回指定頁面的影像索引。

傳回指定頁面的字串。

傳回目前選取的頁面,如果沒有選取任何頁面則傳回 wxNOT\_FOUND

傳回指定位置的索引標籤索引,如果沒有則傳回 wxNOT\_FOUND

在指定位置插入一個新頁面。

建構一個 choicebook 控制項。

設定要使用的影像列表。

設定指定頁面的影像索引。

設定頁面的寬度和高度。

設定指定頁面的文字。

將選擇設定為指定的頁面,並傳回先前的選擇。

類型

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

函式

此函式的連結

addPage(This, Page, Text)

檢視原始碼
-spec addPage(This, Page, Text) -> boolean()
                 when This :: wxToolbook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata().

等同於 addPage(This, Page, Text, [])

-spec addPage(This, Page, Text, [Option]) -> boolean()
                 when
                     This :: wxToolbook(),
                     Page :: wxWindow:wxWindow(),
                     Text :: unicode:chardata(),
                     Option :: {bSelect, boolean()} | {imageId, integer()}.

新增一個新頁面。

頁面必須將書本控制項本身做為父項,且不得先前已加入此控制項。

如果 select 為 true,則呼叫此函式會產生頁面變更中和頁面已變更事件,但在插入第一個頁面時不會產生(因為這種情況下沒有先前的頁面選取可供切換,因此例如否決此類事件是沒有意義的)。

傳回值:如果成功則傳回 true,否則傳回 false。

備註:請勿刪除頁面,書本控制項會刪除它。

請參閱:insertPage/5

此函式的連結

advanceSelection(This)

檢視原始碼
-spec advanceSelection(This) -> ok when This :: wxToolbook().

等同於 advanceSelection(This, [])

-spec advanceSelection(This, [Option]) -> ok when This :: wxToolbook(), Option :: {forward, boolean()}.

在索引標籤之間循環。

呼叫此函式會產生頁面變更中事件。

此函式的連結

assignImageList(This, ImageList)

檢視原始碼
-spec assignImageList(This, ImageList) -> ok
                         when This :: wxToolbook(), ImageList :: wxImageList:wxImageList().

設定頁面控制項的影像列表並取得該列表的所有權。

請參閱

此函式的連結

changeSelection(This, Page)

檢視原始碼
-spec changeSelection(This, Page) -> integer() when This :: wxToolbook(), Page :: integer().

將選擇變更為指定的頁面,並傳回先前的選擇。

此函式的行為與 setSelection/2 相同,但 不會 產生頁面變更中事件。

如需更多資訊,請參閱 overview_events_prog。

此函式的連結

create(This, Parent, Id)

檢視原始碼
-spec create(This, Parent, Id) -> boolean()
                when This :: wxToolbook(), Parent :: wxWindow:wxWindow(), Id :: integer().

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

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

建立已經使用預設建構函式建構的工具書控制項。

-spec deleteAllPages(This) -> boolean() when This :: wxToolbook().

刪除所有頁面。

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

銷毀物件

-spec getCurrentPage(This) -> wxWindow:wxWindow() when This :: wxToolbook().

傳回目前選取的頁面,如果沒有則傳回 NULL。

-spec getImageList(This) -> wxImageList:wxImageList() when This :: wxToolbook().

傳回關聯的影像列表,可能為 NULL。

請參閱

-spec getPage(This, Page) -> wxWindow:wxWindow() when This :: wxToolbook(), Page :: integer().

傳回指定頁面位置的視窗。

-spec getPageCount(This) -> integer() when This :: wxToolbook().

傳回控制項中的頁面數量。

此函式的連結

getPageImage(This, NPage)

檢視原始碼
-spec getPageImage(This, NPage) -> integer() when This :: wxToolbook(), NPage :: integer().

傳回指定頁面的影像索引。

此函式的連結

getPageText(This, NPage)

檢視原始碼
-spec getPageText(This, NPage) -> unicode:charlist() when This :: wxToolbook(), NPage :: integer().

傳回指定頁面的字串。

-spec getSelection(This) -> integer() when This :: wxToolbook().

傳回目前選取的頁面,如果沒有選取任何頁面則傳回 wxNOT\_FOUND

請注意,從 EVT_BOOKCTRL_PAGE_CHANGED 處理常式呼叫時,此方法可能會根據平台傳回先前或新選取的頁面,因此在這種情況下應改用 wxBookCtrlEvent:getSelection/1

-spec hitTest(This, Pt) -> Result
                 when
                     Result :: {Res :: integer(), Flags :: integer()},
                     This :: wxToolbook(),
                     Pt :: {X :: integer(), Y :: integer()}.

傳回指定位置的索引標籤索引,如果沒有則傳回 wxNOT\_FOUND

如果 flags 參數為非 NULL,也會傳回點在索引標籤內的相對位置。

傳回值:傳回從零開始的索引標籤索引,如果指定位置沒有索引標籤,則傳回 wxNOT_FOUND

此函式的連結

insertPage(This, Index, Page, Text)

檢視原始碼
-spec insertPage(This, Index, Page, Text) -> boolean()
                    when
                        This :: wxToolbook(),
                        Index :: integer(),
                        Page :: wxWindow:wxWindow(),
                        Text :: unicode:chardata().

等同於 insertPage(This, Index, Page, Text, [])

-spec insertPage(This, Index, Page, Text, [Option]) -> boolean()
                    when
                        This :: wxToolbook(),
                        Index :: integer(),
                        Page :: wxWindow:wxWindow(),
                        Text :: unicode:chardata(),
                        Option :: {bSelect, boolean()} | {imageId, integer()}.

在指定位置插入一個新頁面。

傳回值:如果成功則傳回 true,否則傳回 false。

備註:請勿刪除頁面,書本控制項會刪除它。

請參閱:addPage/4

-spec new() -> wxToolbook().

建構一個 choicebook 控制項。

-spec new(Parent, Id) -> wxToolbook() when Parent :: wxWindow:wxWindow(), Id :: integer().

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

-spec new(Parent, Id, [Option]) -> wxToolbook()
             when
                 Parent :: wxWindow:wxWindow(),
                 Id :: integer(),
                 Option ::
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()}.
此函式的連結

setImageList(This, ImageList)

檢視原始碼
-spec setImageList(This, ImageList) -> ok
                      when This :: wxToolbook(), ImageList :: wxImageList:wxImageList().

設定要使用的影像列表。

它不取得影像列表的所有權,您必須自行刪除它。

請參閱

此函式的連結

setPageImage(This, Page, Image)

檢視原始碼
-spec setPageImage(This, Page, Image) -> boolean()
                      when This :: wxToolbook(), Page :: integer(), Image :: integer().

設定指定頁面的影像索引。

image 是使用 setImageList/2 設定的影像列表中的索引。

此函式的連結

setPageSize(This, Size)

檢視原始碼
-spec setPageSize(This, Size) -> ok when This :: wxToolbook(), Size :: {W :: integer(), H :: integer()}.

設定頁面的寬度和高度。

注意:目前 wxGTK 未實作此方法。

此函式的連結

setPageText(This, Page, Text)

檢視原始碼
-spec setPageText(This, Page, Text) -> boolean()
                     when This :: wxToolbook(), Page :: integer(), Text :: unicode:chardata().

設定指定頁面的文字。

此函式的連結

setSelection(This, Page)

檢視原始碼
-spec setSelection(This, Page) -> integer() when This :: wxToolbook(), Page :: integer().

將選擇設定為指定的頁面,並傳回先前的選擇。

請注意,呼叫此函式會產生頁面變更中事件,如果您不希望產生這些事件,請使用 changeSelection/2 函式。

請參閱:getSelection/1