檢視原始碼 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 決定停靠窗格的列。
將 PaneInfo 物件 "source" 的安全部分寫入 "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().
將 PaneInfo 物件 "source" 的安全部分寫入 "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 結構。