查看源代码 wxListbook (wx v2.4.3)
wxListbook
是一个类似于 wxNotebook
的类,但它使用 wxListCtrl
来显示标签,而不是选项卡。
默认情况下,底层的 wxListCtrl
在单列报表视图中显示页面标签。调用 wxBookCtrl::SetImageList 会隐式地将控件切换为使用图标视图。
有关此类的使用文档,请参阅基抽象类 wxBookCtrl。您还可以使用 page_samples_notebook 来查看 wxListbook
的实际效果。
样式
此类支持以下样式
wxLB_DEFAULT:根据当前平台选择标签的默认位置(除 Mac 外,其他地方均为左侧,Mac 为顶部)。
wxLB_TOP:将标签放置在页面区域上方。
wxLB_LEFT:将标签放置在左侧。
wxLB_RIGHT:将标签放置在右侧。
wxLB_BOTTOM:将标签放置在页面区域下方。
参见
?wxBookCtrl
此类派生自以下类,并且可以使用以下类中的函数:
wxWidgets 文档: wxListbook
事件
此类发出的事件类型
摘要
函数
添加一个新页面。
循环浏览选项卡。
为页面控件设置图像列表并获得列表的所有权。
将选择更改为给定页面,返回之前的选择。
创建已使用默认构造函数构造的列表书控件。
删除所有页面。
销毁对象
返回当前选定的页面或 NULL。
返回关联的图像列表,可能为 NULL。
返回给定页面位置的窗口。
返回控件中的页面数。
返回给定页面的图像索引。
返回给定页面的字符串。
返回当前选定的页面,如果没有选择任何页面,则返回 wxNOT\_FOUND
。
返回指定位置的选项卡的索引,如果没有,则返回 wxNOT\_FOUND
。
在指定位置插入一个新页面。
默认构造函数。
构造一个列表书控件。
设置要使用的图像列表。
设置给定页面的图像索引。
设置页面的宽度和高度。
设置给定页面的文本。
将选择设置为给定页面,返回之前的选择。
类型
-type wxListbook() :: wx:wx_object().
函数
-spec addPage(This, Page, Text) -> boolean() when This :: wxListbook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata().
-spec addPage(This, Page, Text, [Option]) -> boolean() when This :: wxListbook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata(), Option :: {bSelect, boolean()} | {imageId, integer()}.
添加一个新页面。
页面必须将书控件本身作为父级,并且以前未添加到此控件中。
如果 select
为 true,则对此函数的调用将生成页面更改和页面已更改事件,但在插入第一个页面时不会生成(因为在这种情况下没有要切换的先前页面选择,因此例如否决此类事件是没有意义的)。
返回:如果成功,则返回 true,否则返回 false。
备注:不要删除页面,它将被书控件删除。
参见:insertPage/5
-spec advanceSelection(This) -> ok when This :: wxListbook().
-spec advanceSelection(This, [Option]) -> ok when This :: wxListbook(), Option :: {forward, boolean()}.
循环浏览选项卡。
对此函数的调用会生成页面正在更改事件。
-spec assignImageList(This, ImageList) -> ok when This :: wxListbook(), ImageList :: wxImageList:wxImageList().
为页面控件设置图像列表并获得列表的所有权。
参见
-spec changeSelection(This, Page) -> integer() when This :: wxListbook(), Page :: integer().
将选择更改为给定页面,返回之前的选择。
此函数的行为与 setSelection/2
相同,但 不会
生成页面正在更改事件。
有关更多信息,请参见 overview_events_prog。
-spec create(This, Parent, Id) -> boolean() when This :: wxListbook(), Parent :: wxWindow:wxWindow(), Id :: integer().
-spec create(This, Parent, Id, [Option]) -> boolean() when This :: wxListbook(), Parent :: wxWindow:wxWindow(), Id :: integer(), Option :: {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()}.
创建已使用默认构造函数构造的列表书控件。
-spec deleteAllPages(This) -> boolean() when This :: wxListbook().
删除所有页面。
-spec destroy(This :: wxListbook()) -> ok.
销毁对象
-spec getCurrentPage(This) -> wxWindow:wxWindow() when This :: wxListbook().
返回当前选定的页面或 NULL。
-spec getImageList(This) -> wxImageList:wxImageList() when This :: wxListbook().
返回关联的图像列表,可能为 NULL。
参见
-spec getPage(This, Page) -> wxWindow:wxWindow() when This :: wxListbook(), Page :: integer().
返回给定页面位置的窗口。
-spec getPageCount(This) -> integer() when This :: wxListbook().
返回控件中的页面数。
-spec getPageImage(This, NPage) -> integer() when This :: wxListbook(), NPage :: integer().
返回给定页面的图像索引。
-spec getPageText(This, NPage) -> unicode:charlist() when This :: wxListbook(), NPage :: integer().
返回给定页面的字符串。
-spec getSelection(This) -> integer() when This :: wxListbook().
返回当前选定的页面,如果没有选择任何页面,则返回 wxNOT\_FOUND
。
请注意,当从 EVT_BOOKCTRL_PAGE_CHANGED
处理程序调用时,此方法可能会返回先前或新选择的页面,具体取决于平台,因此在这种情况下应使用 wxBookCtrlEvent:getSelection/1
。
-spec hitTest(This, Pt) -> Result when Result :: {Res :: integer(), Flags :: integer()}, This :: wxListbook(), Pt :: {X :: integer(), Y :: integer()}.
返回指定位置的选项卡的索引,如果没有,则返回 wxNOT\_FOUND
。
如果 flags
参数为非 NULL,则也会返回点在选项卡内的位置。
返回:返回从零开始的选项卡索引,如果指定位置没有选项卡,则返回 wxNOT_FOUND
。
-spec insertPage(This, Index, Page, Text) -> boolean() when This :: wxListbook(), Index :: integer(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata().
-spec insertPage(This, Index, Page, Text, [Option]) -> boolean() when This :: wxListbook(), Index :: integer(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata(), Option :: {bSelect, boolean()} | {imageId, integer()}.
在指定位置插入一个新页面。
返回:如果成功,则返回 true,否则返回 false。
备注:不要删除页面,它将被书控件删除。
参见:addPage/4
-spec new() -> wxListbook().
默认构造函数。
-spec new(Parent, Id) -> wxListbook() when Parent :: wxWindow:wxWindow(), Id :: integer().
等效于 new(Parent, Id, [])
。
-spec new(Parent, Id, [Option]) -> wxListbook() when Parent :: wxWindow:wxWindow(), Id :: integer(), Option :: {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()}.
构造一个列表书控件。
-spec setImageList(This, ImageList) -> ok when This :: wxListbook(), ImageList :: wxImageList:wxImageList().
设置要使用的图像列表。
它不拥有图像列表的所有权,您必须自己删除它。
参见
-spec setPageImage(This, Page, Image) -> boolean() when This :: wxListbook(), Page :: integer(), Image :: integer().
设置给定页面的图像索引。
image
是使用 setImageList/2
设置的图像列表的索引。
-spec setPageSize(This, Size) -> ok when This :: wxListbook(), Size :: {W :: integer(), H :: integer()}.
设置页面的宽度和高度。
注意:此方法目前未在 wxGTK 中实现。
-spec setPageText(This, Page, Text) -> boolean() when This :: wxListbook(), Page :: integer(), Text :: unicode:chardata().
设置给定页面的文本。
-spec setSelection(This, Page) -> integer() when This :: wxListbook(), Page :: integer().
将选择设置为给定页面,返回之前的选择。
请注意,调用此函数会生成页面正在更改事件,如果您不希望生成这些事件,请使用 changeSelection/2
函数。