wxAuiPaneInfo(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

okay bestie, this is the manual page for wxAuiPaneInfo(3) — it's an Erlang module definition. part 1 of 2, so buckle up. 💅✨

✨ NAME ✨

wxAuiPaneInfo — so like, wxAuiPaneInfo is part of the wxAUI class framework. 💖

💖 DESCRIPTION 💖

See also overview_aui. 👀

wxAuiPaneInfo specifies all the parameters for a pane. These parameters specify where the pane is on the screen, whether it is docked or floating, or hidden. In addition, these parameters specify the pane's docked position, floating position, preferred size, minimum size, caption text among many other parameters. it's giving very detailed, no cap. 💅

See:

  • wxAuiManager
  • wxAuiDockArt

wxWidgets docs: wxAuiPaneInfo

🌸 DATA TYPES 🌸

wxAuiPaneInfo() :: wx:wx_object().

🔥 FUNCTIONS 🔥

bestSize(This, Size) -> wxAuiPaneInfo()

bestSize(This, Size) -> wxAuiPaneInfo()
                  when
                      This :: wxAuiPaneInfo(),
                      Size :: {W :: integer(), H :: integer()}.

bestSize/3 sets the ideal size for the pane. The docking manager will attempt to use this size as much as possible when docking or floating the pane. 🎯

bestSize(This, X, Y) -> wxAuiPaneInfo()

bestSize(This, X, Y) -> wxAuiPaneInfo()
                  when
                      This :: wxAuiPaneInfo(),
                      X :: integer(),
                      Y :: integer().

no deets on this one, bestie. the manual is silent. 🙈

bottom(This) -> wxAuiPaneInfo()

bottom(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

bottom/1 sets the pane dock position to the bottom side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM). 🍑

bottomDockable(This, [Option]) -> wxAuiPaneInfo()

bottomDockable(This, [Option]) -> wxAuiPaneInfo()
                          when
                              This :: wxAuiPaneInfo(),
                              Option :: {b, boolean()}.

bottomDockable/2 indicates whether a pane can be docked at the bottom of the frame. 👇

caption(This, C) -> wxAuiPaneInfo()

caption(This, C) -> wxAuiPaneInfo()
                 when This :: wxAuiPaneInfo(), C :: unicode:chardata().

caption/2 sets the caption of the pane. 📝

captionVisible(This, [Option]) -> wxAuiPaneInfo()

captionVisible(This, [Option]) -> wxAuiPaneInfo()
                          when
                              This :: wxAuiPaneInfo(),
                              Option :: {visible, boolean()}.

CaptionVisible indicates that a pane caption should be visible. If false, no pane caption is drawn. 👀

centre(This) -> wxAuiPaneInfo()

centre(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

Center() (not implemented in wx) sets the pane dock position to the left side of the frame. The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. This is the same thing as calling Direction(wxAUI_DOCK_CENTRE). 🎯

centrePane(This) -> wxAuiPaneInfo()

centrePane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

centrePane/1 specifies that the pane should adopt the default center pane settings. Centre panes usually do not have caption bars. This function provides an easy way of preparing a pane to be displayed in the center dock position. 💅

closeButton(This, [Option]) -> wxAuiPaneInfo()

closeButton(This, [Option]) -> wxAuiPaneInfo()
                       when
                           This :: wxAuiPaneInfo(),
                           Option :: {visible, boolean()}.

closeButton/2 indicates that a close button should be drawn for the pane. ❌

defaultPane(This) -> wxAuiPaneInfo()

defaultPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

defaultPane/1 specifies that the pane should adopt the default pane settings. ✨

destroy(This :: wxAuiPaneInfo()) -> ok.

destroy(This :: wxAuiPaneInfo()) -> ok.

Destroys the object. 💀

destroyOnClose(This, [Option]) -> wxAuiPaneInfo()

destroyOnClose(This, [Option]) -> wxAuiPaneInfo()
                          when
                              This :: wxAuiPaneInfo(),
                              Option :: {b, boolean()}.

destroyOnClose/2 indicates whether a pane should be destroyed when it is closed. Normally a pane is simply hidden when the close button is clicked. Setting DestroyOnClose to true will cause the window to be destroyed when the user clicks the pane's close button. 💥

direction(This, Direction) -> wxAuiPaneInfo()

direction(This, Direction) -> wxAuiPaneInfo()
                     when This :: wxAuiPaneInfo(), Direction :: integer().

direction/2 determines the direction of the docked pane. It is functionally the same as calling left/1, right/1, top/1 or bottom/1, except that docking direction may be specified programmatically via the parameter. 🧭

dock(This) -> wxAuiPaneInfo()

dock(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

dock/1 indicates that a pane should be docked. It is the opposite of float/1. ⚓

dockable(This, [Option]) -> wxAuiPaneInfo()

dockable(This, [Option]) -> wxAuiPaneInfo()
                    when This :: wxAuiPaneInfo(), Option :: {b,
    boolean()}.

dockable/2 specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b). 📦

fixed(This) -> wxAuiPaneInfo()

fixed(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

fixed/1 forces a pane to be fixed size so that it cannot be resized. After calling fixed/1, isFixed/1 will return true. 🔒

float(This) -> wxAuiPaneInfo()

float(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

float/1 indicates that a pane should be floated. It is the opposite of dock/1. 🎈

floatable(This, [Option]) -> wxAuiPaneInfo()

floatable(This, [Option]) -> wxAuiPaneInfo()
                     when
                         This :: wxAuiPaneInfo(), Option :: {b,
    boolean()}.

floatable/2 sets whether the user will be able to undock a pane and turn it into a floating window. 🪟

floatingPosition(This, Pos) -> wxAuiPaneInfo()

floatingPosition(This, Pos) -> wxAuiPaneInfo()
                            when
                                This :: wxAuiPaneInfo(),
                                Pos :: {X :: integer(), Y :: integer()}.

floatingPosition/3 sets the position of the floating pane. 📍

floatingPosition(This, X, Y) -> wxAuiPaneInfo()

floatingPosition(This, X, Y) -> wxAuiPaneInfo()
                            when
                                This :: wxAuiPaneInfo(),
                                X :: integer(),
                                Y :: integer().

no description, just vibes. 🌈

floatingSize(This, Size) -> wxAuiPaneInfo()

floatingSize(This, Size) -> wxAuiPaneInfo()
                        when
                            This :: wxAuiPaneInfo(),
                            Size :: {W :: integer(), H :: integer()}.

floatingSize/3 sets the size of the floating pane. 📐

floatingSize(This, X, Y) -> wxAuiPaneInfo()

floatingSize(This, X, Y) -> wxAuiPaneInfo()
                        when
                            This :: wxAuiPaneInfo(),
                            X :: integer(),
                            Y :: integer().

silent again, bestie. 😭

getDirection(This) -> integer()

getDirection(This) -> integer() when This :: wxAuiPaneInfo().

getFloatingPosition(This) -> {X :: integer(), Y :: integer()}

getFloatingPosition(This) -> {X :: integer(), Y :: integer()}
                            when This :: wxAuiPaneInfo().

getFloatingSize(This) -> {W :: integer(), H :: integer()}

getFloatingSize(This) -> {W :: integer(), H :: integer()}
                        when This :: wxAuiPaneInfo().

getFrame(This) -> wxFrame:wxFrame()

getFrame(This) -> wxFrame:wxFrame() when This :: wxAuiPaneInfo().

getLayer(This) -> integer()

getLayer(This) -> integer() when This :: wxAuiPaneInfo().

getPosition(This) -> integer()

getPosition(This) -> integer() when This :: wxAuiPaneInfo().

getRow(This) -> integer()

getRow(This) -> integer() when This :: wxAuiPaneInfo().

getWindow(This) -> wxWindow:wxWindow()

getWindow(This) -> wxWindow:wxWindow()
                  when This :: wxAuiPaneInfo().

gripper(This, [Option]) -> wxAuiPaneInfo()

gripper(This, [Option]) -> wxAuiPaneInfo()
                   when
                       This :: wxAuiPaneInfo(),
                       Option :: {visible, boolean()}.

gripper/2 indicates that a gripper should be drawn for the pane. 🎀

gripperTop(This, [Option]) -> wxAuiPaneInfo()

gripperTop(This, [Option]) -> wxAuiPaneInfo()
                      when
                          This :: wxAuiPaneInfo(),
                          Option :: {attop, boolean()}.

gripperTop/2 indicates that a gripper should be drawn at the top of the pane. 🔝

hasBorder(This) -> boolean()

hasBorder(This) -> boolean() when This :: wxAuiPaneInfo().

hasBorder/1 returns true if the pane displays a border. 🖼️

hasCaption(This) -> boolean()

hasCaption(This) -> boolean() when This :: wxAuiPaneInfo().

hasCaption/1 returns true if the pane displays a caption. 🏷️

hasCloseButton(This) -> boolean()

hasCloseButton(This) -> boolean() when This :: wxAuiPaneInfo().

hasCloseButton/1 returns true if the pane displays a button to close the pane. ❌

hasFlag(This, Flag) -> boolean()

hasFlag(This, Flag) -> boolean()
                when This :: wxAuiPaneInfo(), Flag :: integer().

hasFlag/2 returns true if the property specified by flag is active for the pane. 🚩

hasGripper(This) -> boolean()

hasGripper(This) -> boolean() when This :: wxAuiPaneInfo().

hasGripper/1 returns true if the pane displays a gripper. 🎀

hasGripperTop(This) -> boolean()

hasGripperTop(This) -> boolean() when This :: wxAuiPaneInfo().

hasGripper/1 returns true if the pane displays a gripper at the top. (yes, it says hasGripper/1 — we're just the messenger. 😭)

hasMaximizeButton(This) -> boolean()

hasMaximizeButton(This) -> boolean() when This :: wxAuiPaneInfo().

hasMaximizeButton/1 returns true if the pane displays a button to maximize the pane. 🔼

hasMinimizeButton(This) -> boolean()

hasMinimizeButton(This) -> boolean() when This :: wxAuiPaneInfo().

hasMinimizeButton/1 returns true if the pane displays a button to minimize the pane. 🔽

hasPinButton(This) -> boolean()

hasPinButton(This) -> boolean() when This :: wxAuiPaneInfo().

hasPinButton/1 returns true if the pane displays a button to float the pane. 📌

hide(This) -> wxAuiPaneInfo()

hide(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().

hide/1 indicates that a pane should be hidden. 🙈

isBottomDockable(This) -> boolean()

isBottomDockable(This) -> boolean() when This :: wxAuiPaneInfo().

isBottomDockable/1 returns true if the pane can be docked at the bottom of the managed frame. 👇

isDocked(This) -> boolean()

isDocked(This) -> boolean() when This :: wxAuiPaneInfo().

isDocked/1 returns true if the pane is currently docked. ⚓

isFixed(This) -> boolean()

isFixed(This) -> boolean() when This :: wxAuiPaneInfo().

isFixed/1 returns true if the pane cannot be resized. 🔒

isFloatable(This) -> boolean()

isFloatable(This) -> boolean() when This :: wxAuiPaneInfo().

isFloatable/1 returns true if the pane can be undocked and displayed as a floating window. 🪟

isFloating(This) -> boolean()

isFloating(This) -> boolean() when This :: wxAuiPaneInfo().

isFloating/1 returns true if the pane is floating. 🎈

isLeftDockable(This) -> boolean()

isLeftDockable(This) -> boolean() when This :: wxAuiPaneInfo().

isLeftDockable/1 returns true if the pane can be docked on the left of the managed frame. 👈

isMovable(This) -> boolean()

isMovable(This) -> boolean() when This :: wxAuiPaneInfo().

IsMoveable() returns true if the docked frame can be undocked or moved to another dock position. (capital I, extra e, we don't make the rules. 💅)

isOk(This) -> boolean()

isOk(This) -> boolean() when This :: wxAuiPaneInfo().

isOk/1 returns true if the wxAuiPaneInfo structure is valid. A pane structure is valid if it has an associated window. ✅

isResizable(This) -> boolean()

isResizable(This) -> boolean() when This :: wxAuiPaneInfo().

isResizable/1 returns true if the pane can be resized. ↔️

isRightDockable(This) -> boolean()

isRightDockable(This) -> boolean() when This :: wxAuiPaneInfo().

isRightDockable/1 returns true if the pane can be docked on the right of the managed frame. 👉

isShown(This) -> boolean()

isShown(This) -> boolean() when This :: wxAuiPaneInfo().

isShown/1 returns true if the pane is currently shown. 👀

isToolbar(This) -> boolean()

isToolbar(This) -> boolean() when This :: wxAuiPaneInfo().

and that's where part 1 leaves us, bestie. more coming in part 2, so don't go anywhere. 💖

  • isToolbar/1 — returns true if the pane contains a toolbar. 🛠️✨
  • isTopDockable/1 — isTopDockable(This) -> boolean() when This :: wxAuiPaneInfo(). — Returns true if the pane can be docked at the top of the managed frame. 💅
  • layer/2 — layer(This, Layer) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Layer :: integer(). — Determines the layer of the docked pane. 🧅

The dock layer is like an onion, bestie — the inner-most layer is layer 0. Each shell moving outward has a higher layer number. This allows for more complex docking layout formation. 🌈✨

  • left/1 — left(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(). — Sets the pane dock position to the left side of the frame. 👈

This is the same thing as calling Direction(wxAUI_DOCK_LEFT). 💖

  • leftDockable/2 — leftDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}. — Indicates whether a pane can be docked on the left of the frame. 👈🔒
  • maxSize/3 — maxSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}. and maxSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer(). — Sets the maximum size of the pane. 📏💖
  • maximizeButton/2 — maximizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}. — Indicates that a maximize button should be drawn for the pane. 🔲✨
  • minSize/3 — minSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}. and minSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer(). — Sets the minimum size of the pane. 📏💕
Please note that this is only partially supported as of this writing. 😬
  • minimizeButton/2 — minimizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}. — Indicates that a minimize button should be drawn for the pane. 🔽✨
  • movable/2 — movable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}. — Movable indicates whether a frame can be moved. 🚚💨
  • name/2 — name(This, N) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), N :: unicode:chardata(). — Sets the name of the pane so it can be referenced in lookup functions. 📛✨

If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager. 🎲

  • new/0 — new() -> wxAuiPaneInfo().
  • new/1 — new(C) -> wxAuiPaneInfo() when C :: wxAuiPaneInfo(). — Copy constructor. 📋💖
  • paneBorder/2 — paneBorder(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}. — PaneBorder indicates that a border should be drawn for the pane. 🖼️✨
  • pinButton/2 — pinButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}. — Indicates that a pin button should be drawn for the pane. 📌✨
  • position/2 — position(This, Pos) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Pos :: integer(). — Determines the position of the docked pane. 📍💖
  • resizable/2 — resizable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {resizable, boolean()}. — Allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false. ↔️✨

This is simply an antonym for fixed/1. 💅

  • right/1 — right(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(). — Sets the pane dock position to the right side of the frame. 👉

This is the same thing as calling Direction(wxAUI_DOCK_RIGHT). 💖

  • rightDockable/2 — rightDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}. — Indicates whether a pane can be docked on the right of the frame. 👉🔒
  • row/2 — row(This, Row) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Row :: integer(). — Determines the row of the docked pane. 📏✨
  • safeSet/2 — safeSet(This, Source) -> ok when This :: wxAuiPaneInfo(), Source :: wxAuiPaneInfo(). — Write the safe parts of a PaneInfo object "source" into "this". 📝✨

"Safe parts" are all non-UI elements (e.g. all layout determining parameters like the size, position etc.). "Unsafe parts" (pointers to button, frame and window) are not modified by this write operation. 🚫🖱️

Remark: This method is used when loading perspectives. 👀
  • setFlag/3 — setFlag(This, Flag, Option_state) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Flag :: integer(), Option_state :: boolean(). — Turns the property given by flag on or off with the option_state parameter. 🚩✨
  • show/2 — show(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {show, boolean()}. — Indicates that a pane should be shown. 👀✨
  • toolbarPane/1 — toolbarPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(). — Specifies that the pane should adopt the default toolbar pane settings. 🛠️✨
  • top/1 — top(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(). — Sets the pane dock position to the top of the frame. 👆

This is the same thing as calling Direction(wxAUI_DOCK_TOP). 💖

  • topDockable/2 — topDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}. — Indicates whether a pane can be docked at the top of the frame. 👆🔒
  • window/2 — window(This, W) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), W :: wxWindow:wxWindow(). — Assigns the window pointer that the wxAuiPaneInfo should use. 🪟✨

This normally does not need to be specified, as the window pointer is automatically assigned to the wxAuiPaneInfo structure as soon as it is added to the manager. 🤖

That's a wrap, bestie! This manual page was brought to you by Ericsson AB, wx 2.6, and the iconic wxAuiPaneInfo(3). Stay slaying! 💅✨
📦 where this page comes from