查看源码 wxAuiPaneInfo (wx v2.4.3)
wxAuiPaneInfo 是 wxAUI 类框架的一部分。
另请参阅 overview_aui。
wxAuiPaneInfo 指定窗格的所有参数。这些参数指定窗格在屏幕上的位置，是否停靠、浮动或隐藏。此外，这些参数还指定窗格的停靠位置、浮动位置、首选大小、最小大小、标题文本等许多其他参数。
请参阅
wxWidgets 文档：wxAuiPaneInfo
摘要
函数
bestSize/3 设置窗格的理想大小。
bottom/1 将窗格停靠位置设置为框架的底部。
bottomDockable/2 指示窗格是否可以停靠在框架的底部。
caption/2 设置窗格的标题。
CaptionVisible 表示窗格标题应可见。
Center()（在 wx 中未实现）将窗格停靠位置设置为框架的左侧。
centrePane/1 指定窗格应采用默认的中心窗格设置。
closeButton/2 表示应为窗格绘制一个关闭按钮。
defaultPane/1 指定窗格应采用默认的窗格设置。
销毁对象
destroyOnClose/2 指示是否应在关闭窗格时销毁该窗格。
direction/2 确定停靠窗格的方向。
dock/1 表示应停靠窗格。
dockable/2 指定框架是否可以停靠。
fixed/1 强制窗格固定大小，使其无法调整大小。
float/1 表示应浮动窗格。
floatable/2 设置用户是否能够取消停靠窗格并将其转换为浮动窗口。
floatingPosition/3 设置浮动窗格的位置。
floatingSize/3 设置浮动窗格的大小。
gripperTop/2 表示应在窗格顶部绘制一个抓取器。
hasBorder/1 如果窗格显示边框，则返回 true。
hasCaption/1 如果窗格显示标题，则返回 true。
hasCloseButton/1 如果窗格显示关闭窗格的按钮，则返回 true。
hasFlag/2 如果窗格的 flag 指定的属性处于活动状态，则返回 true。
hasGripper/1 如果窗格显示抓取器，则返回 true。
hasGripper/1 如果窗格顶部显示抓取器，则返回 true。
hasMaximizeButton/1 如果窗格显示最大化窗格的按钮，则返回 true。
hasMinimizeButton/1 如果窗格显示最小化窗格的按钮，则返回 true。
hasPinButton/1 如果窗格显示用于浮动窗格的按钮，则返回 true。
hide/1 表示应隐藏窗格。
isBottomDockable/1 如果窗格可以停靠在受管理的框架的底部，则返回 true。
isDocked/1 如果窗格当前已停靠，则返回 true。
isFixed/1 如果窗格无法调整大小，则返回 true。
isFloatable/1 如果窗格可以取消停靠并显示为浮动窗口，则返回 true。
isFloating/1 如果窗格正在浮动，则返回 true。
isLeftDockable/1 如果窗格可以停靠在受管理的框架的左侧，则返回 true。
IsMoveable() 如果停靠的框架可以取消停靠或移动到另一个停靠位置，则返回 true。
isOk/1 如果 wxAuiPaneInfo 结构有效，则返回 true。
isResizable/1 如果可以调整窗格的大小，则返回 true。
isRightDockable/1 如果窗格可以停靠在受管理的框架的右侧，则返回 true。
isShown/1 如果窗格当前正在显示，则返回 true。
isToolbar/1 如果窗格包含工具栏，则返回 true。
isTopDockable/1 如果窗格可以停靠在受管理的框架的顶部，则返回 true。
layer/2 确定停靠窗格的图层。
left/1 将窗格停靠位置设置为框架的左侧。
leftDockable/2 表示窗格是否可以停靠在框架的左侧。
maximizeButton/2 表示应为窗格绘制一个最大化按钮。
maxSize/3 设置窗格的最大大小。
minimizeButton/2 表示应为窗格绘制一个最小化按钮。
minSize/3 设置窗格的最小大小。
Movable 表示框架是否可以移动。
name/2 设置窗格的名称，以便可以在查找函数中引用它。
复制构造函数。
PaneBorder 表示应为窗格绘制边框。
pinButton/2 表示应为窗格绘制一个固定按钮。
position/2 确定停靠窗格的位置。
resizable/2 如果参数为 true，则允许调整窗格的大小，如果参数为 false，则强制窗格固定大小。
right/1 将窗格停靠位置设置为框架的右侧。
rightDockable/2 表示窗格是否可以停靠在框架的右侧。
row/2 确定停靠窗格的行。
将 "source" PaneInfo 对象中的安全部分写入 "this"。
setFlag/3 使用 option_state 参数打开或关闭由 flag 指定的属性。
等同于 show(This, [])。
toolbarPane/1 指定窗格应采用默认工具栏窗格设置。
topDockable/2 指示窗格是否可以停靠在框架的顶部。
window/2 分配 wxAuiPaneInfo 应该使用的窗口指针。
类型
-type wxAuiPaneInfo() :: wx:wx_object().
函数
-spec bestSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
bestSize/3 设置窗格的理想大小。
当停靠或浮动窗格时，停靠管理器将尝试尽可能使用此大小。
-spec bestSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec bottom(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
bottom/1 将窗格停靠位置设置为框架的底部。
这与调用 Direction(wxAUI_DOCK_BOTTOM) 相同。
-spec bottomDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec bottomDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
bottomDockable/2 指示窗格是否可以停靠在框架的底部。
-spec caption(This, C) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), C :: unicode:chardata().
caption/2 设置窗格的标题。
-spec captionVisible(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec captionVisible(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
CaptionVisible 表示窗格标题应可见。
如果为 false，则不绘制任何窗格标题。
-spec centre(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Center()（在 wx 中未实现）将窗格停靠位置设置为框架的左侧。
中心窗格是布局中减去所有边框窗格（左、上、右、下）后中间的空间。这与调用 Direction(wxAUI_DOCK_CENTRE) 相同。
-spec centrePane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
centrePane/1 指定窗格应采用默认的中心窗格设置。
中心窗格通常没有标题栏。此函数提供了一种在中心停靠位置显示窗格的简便方法。
-spec closeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec closeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
closeButton/2 表示应为窗格绘制一个关闭按钮。
-spec defaultPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
defaultPane/1 指定窗格应采用默认的窗格设置。
-spec destroy(This :: wxAuiPaneInfo()) -> ok.
销毁对象
-spec destroyOnClose(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec destroyOnClose(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
destroyOnClose/2 指示是否应在关闭窗格时销毁该窗格。
通常，当单击关闭按钮时，窗格只是被隐藏。将 DestroyOnClose 设置为 true 将导致在用户单击窗格的关闭按钮时销毁窗口。
-spec direction(This, Direction) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Direction :: integer().
direction/2 确定停靠窗格的方向。
它在功能上与调用 left/1、right/1、top/1 或 bottom/1 相同，只是可以通过参数以编程方式指定停靠方向。
-spec dock(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
dock/1 表示应停靠窗格。
它与 float/1 相反。
-spec dockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 dockable(This, [])。
-spec dockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
dockable/2 指定框架是否可以停靠。
这与指定 TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b) 相同。
-spec fixed(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
fixed/1 强制窗格固定大小，使其无法调整大小。
-spec float(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
float/1 表示应浮动窗格。
它与 dock/1 相反。
-spec floatable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 floatable(This, [])。
-spec floatable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
floatable/2 设置用户是否能够取消停靠窗格并将其转换为浮动窗口。
-spec floatingPosition(This, Pos) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Pos :: {X :: integer(), Y :: integer()}.
floatingPosition/3 设置浮动窗格的位置。
-spec floatingPosition(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec floatingSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
floatingSize/3 设置浮动窗格的大小。
-spec floatingSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec getDirection(This) -> integer() when This :: wxAuiPaneInfo().
-spec getFloatingPosition(This) -> {X :: integer(), Y :: integer()} when This :: wxAuiPaneInfo().
-spec getFloatingSize(This) -> {W :: integer(), H :: integer()} when This :: wxAuiPaneInfo().
-spec getFrame(This) -> wxFrame:wxFrame() when This :: wxAuiPaneInfo().
-spec getLayer(This) -> integer() when This :: wxAuiPaneInfo().
-spec getPosition(This) -> integer() when This :: wxAuiPaneInfo().
-spec getRow(This) -> integer() when This :: wxAuiPaneInfo().
-spec getWindow(This) -> wxWindow:wxWindow() when This :: wxAuiPaneInfo().
-spec gripper(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 gripper(This, [])。
-spec gripper(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
gripper/2 表示应为窗格绘制一个抓取器。
-spec gripperTop(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 gripperTop(This, [])。
-spec gripperTop(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {attop, boolean()}.
gripperTop/2 表示应在窗格顶部绘制一个抓取器。
-spec hasBorder(This) -> boolean() when This :: wxAuiPaneInfo().
hasBorder/1 如果窗格显示边框，则返回 true。
-spec hasCaption(This) -> boolean() when This :: wxAuiPaneInfo().
hasCaption/1 如果窗格显示标题，则返回 true。
-spec hasCloseButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasCloseButton/1 如果窗格显示关闭窗格的按钮，则返回 true。
-spec hasFlag(This, Flag) -> boolean() when This :: wxAuiPaneInfo(), Flag :: integer().
hasFlag/2 如果窗格的 flag 指定的属性处于活动状态，则返回 true。
-spec hasGripper(This) -> boolean() when This :: wxAuiPaneInfo().
hasGripper/1 如果窗格显示抓取器，则返回 true。
-spec hasGripperTop(This) -> boolean() when This :: wxAuiPaneInfo().
hasGripper/1 如果窗格顶部显示抓取器，则返回 true。
-spec hasMaximizeButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasMaximizeButton/1 如果窗格显示最大化窗格的按钮，则返回 true。
-spec hasMinimizeButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasMinimizeButton/1 如果窗格显示最小化窗格的按钮，则返回 true。
-spec hasPinButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasPinButton/1 如果窗格显示用于浮动窗格的按钮，则返回 true。
-spec hide(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
hide/1 表示应隐藏窗格。
-spec isBottomDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isBottomDockable/1 如果窗格可以停靠在受管理的框架的底部，则返回 true。
-spec isDocked(This) -> boolean() when This :: wxAuiPaneInfo().
isDocked/1 如果窗格当前已停靠，则返回 true。
-spec isFixed(This) -> boolean() when This :: wxAuiPaneInfo().
isFixed/1 如果窗格无法调整大小，则返回 true。
-spec isFloatable(This) -> boolean() when This :: wxAuiPaneInfo().
isFloatable/1 如果窗格可以取消停靠并显示为浮动窗口，则返回 true。
-spec isFloating(This) -> boolean() when This :: wxAuiPaneInfo().
isFloating/1 如果窗格正在浮动，则返回 true。
-spec isLeftDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isLeftDockable/1 如果窗格可以停靠在受管理的框架的左侧，则返回 true。
-spec isMovable(This) -> boolean() when This :: wxAuiPaneInfo().
IsMoveable() 如果停靠的框架可以取消停靠或移动到另一个停靠位置，则返回 true。
-spec isOk(This) -> boolean() when This :: wxAuiPaneInfo().
isOk/1 如果 wxAuiPaneInfo 结构有效，则返回 true。
如果窗格结构具有关联的窗口，则它是有效的。
-spec isResizable(This) -> boolean() when This :: wxAuiPaneInfo().
isResizable/1 如果可以调整窗格的大小，则返回 true。
-spec isRightDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isRightDockable/1 如果窗格可以停靠在受管理的框架的右侧，则返回 true。
-spec isShown(This) -> boolean() when This :: wxAuiPaneInfo().
isShown/1 如果窗格当前正在显示，则返回 true。
-spec isToolbar(This) -> boolean() when This :: wxAuiPaneInfo().
isToolbar/1 如果窗格包含工具栏，则返回 true。
-spec isTopDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isTopDockable/1 如果窗格可以停靠在受管理的框架的顶部，则返回 true。
-spec layer(This, Layer) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Layer :: integer().
layer/2 确定停靠窗格的图层。
停靠层类似于洋葱，最内层是第 0 层。每个向外移动的壳层都具有更高的层号。这允许形成更复杂的停靠布局。
-spec left(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
left/1 将窗格停靠位置设置为框架的左侧。
这与调用 Direction(wxAUI_DOCK_LEFT) 相同。
-spec leftDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec leftDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
leftDockable/2 表示窗格是否可以停靠在框架的左侧。
-spec maximizeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec maximizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
maximizeButton/2 表示应为窗格绘制一个最大化按钮。
-spec maxSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
maxSize/3 设置窗格的最大大小。
-spec maxSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec minimizeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec minimizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
minimizeButton/2 表示应为窗格绘制一个最小化按钮。
-spec minSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
minSize/3 设置窗格的最小大小。
请注意，截至撰写本文时，仅部分支持此功能。
-spec minSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec movable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 movable(This, [])。
-spec movable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
Movable 表示框架是否可以移动。
-spec name(This, N) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), N :: unicode:chardata().
name/2 设置窗格的名称，以便可以在查找函数中引用它。
如果用户未指定名称，则在将窗格添加到管理器时，会为窗格分配一个随机名称。
-spec new() -> wxAuiPaneInfo().
-spec new(C) -> wxAuiPaneInfo() when C :: wxAuiPaneInfo().
复制构造函数。
-spec paneBorder(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 paneBorder(This, [])。
-spec paneBorder(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
PaneBorder 表示应为窗格绘制边框。
-spec pinButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 pinButton(This, [])。
-spec pinButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
pinButton/2 表示应为窗格绘制一个固定按钮。
-spec position(This, Pos) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Pos :: integer().
position/2 确定停靠窗格的位置。
-spec resizable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 resizable(This, [])。
-spec resizable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {resizable, boolean()}.
resizable/2 如果参数为 true，则允许调整窗格的大小，如果参数为 false，则强制窗格固定大小。
这只是 fixed/1 的反义词。
-spec right(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
right/1 将窗格停靠位置设置为框架的右侧。
这与调用 Direction(wxAUI_DOCK_RIGHT) 相同。
-spec rightDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec rightDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
rightDockable/2 表示窗格是否可以停靠在框架的右侧。
-spec row(This, Row) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Row :: integer().
row/2 确定停靠窗格的行。
-spec safeSet(This, Source) -> ok when This :: wxAuiPaneInfo(), Source :: wxAuiPaneInfo().
将 "source" PaneInfo 对象中的安全部分写入 "this"。
“安全部分”是所有非 UI 元素（例如，所有布局确定参数，如大小、位置等）。“不安全部分”（指向按钮、框架和窗口的指针）不会通过此写入操作进行修改。
备注：此方法在加载视角时使用。
-spec setFlag(This, Flag, Option_state) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Flag :: integer(), Option_state :: boolean().
setFlag/3 使用 option_state 参数打开或关闭由 flag 指定的属性。
-spec show(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
等同于 show(This, [])。
-spec show(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {show, boolean()}.
show/2 指示应该显示窗格。
-spec toolbarPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
toolbarPane/1 指定窗格应采用默认工具栏窗格设置。
-spec top(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
top/1 将窗格的停靠位置设置为框架的顶部。
这与调用 Direction(wxAUI_DOCK_TOP) 相同。
-spec topDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
-spec topDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
topDockable/2 指示窗格是否可以停靠在框架的顶部。
-spec window(This, W) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), W :: wxWindow:wxWindow().
window/2 分配 wxAuiPaneInfo 应该使用的窗口指针。
通常不需要指定此项，因为只要将窗口指针添加到管理器，它就会自动分配给 wxAuiPaneInfo 结构。