Class: Wx::AUI::AuiPaneInfo
- Inherits:
-
Object
- Object
- Wx::AUI::AuiPaneInfo
- Defined in:
- lib/wx/doc/gen/aui/aui_pane_info.rb
Overview
This class is untracked and should not be derived from nor instances extended!
AuiPaneInfo is part of the Wx::AUI class framework.
See also wxAUI Overview. AuiPaneInfo 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.
Category: Window Docking (wxAUI)
Instance Method Summary collapse
-
#best_size ⇒ Wx::Size
size that the layout engine will prefer.
-
#bottom ⇒ Wx::AUI::AuiPaneInfo
#bottom sets the pane dock position to the bottom side of the frame.
-
#caption ⇒ String
caption displayed on the window.
- #center ⇒ Wx::AUI::AuiPaneInfo
- #center_pane ⇒ Wx::AUI::AuiPaneInfo
-
#centre ⇒ Wx::AUI::AuiPaneInfo
#center sets the pane dock position to the left side of the frame.
-
#centre_pane ⇒ Wx::AUI::AuiPaneInfo
#centre_pane specifies that the pane should adopt the default center pane settings.
-
#default_pane ⇒ Wx::AUI::AuiPaneInfo
#default_pane specifies that the pane should adopt the default pane settings.
-
#direction ⇒ Integer
dock direction (top, bottom, left, right, center).
-
#dock ⇒ Wx::AUI::AuiPaneInfo
#dock indicates that a pane should be docked.
-
#fixed ⇒ Wx::AUI::AuiPaneInfo
#fixed forces a pane to be fixed size so that it cannot be resized.
-
#float ⇒ Wx::AUI::AuiPaneInfo
#float indicates that a pane should be floated.
-
#floating_position ⇒ Wx::Point
position while floating.
-
#floating_size ⇒ Wx::Size
size while floating.
-
#frame ⇒ Wx::Frame
floating frame window that holds the pane.
-
#has_border ⇒ Boolean
(also: #has_border?)
#has_border returns true if the pane displays a border.
-
#has_caption ⇒ Boolean
(also: #has_caption?)
#has_caption returns true if the pane displays a caption.
-
#has_close_button ⇒ Boolean
(also: #has_close_button?)
#has_close_button returns true if the pane displays a button to close the pane.
-
#has_flag(flag) ⇒ Boolean
(also: #has_flag?)
#has_flag returns true if the property specified by flag is active for the pane.
-
#has_gripper ⇒ Boolean
(also: #has_gripper?)
#has_gripper returns true if the pane displays a gripper.
-
#has_gripper_top ⇒ Boolean
(also: #has_gripper_top?)
#has_gripper returns true if the pane displays a gripper at the top.
-
#has_maximize_button ⇒ Boolean
(also: #has_maximize_button?)
#has_maximize_button returns true if the pane displays a button to maximize the pane.
-
#has_minimize_button ⇒ Boolean
(also: #has_minimize_button?)
#has_minimize_button returns true if the pane displays a button to minimize the pane.
-
#has_pin_button ⇒ Boolean
(also: #has_pin_button?)
#has_pin_button returns true if the pane displays a button to float the pane.
-
#hide ⇒ Wx::AUI::AuiPaneInfo
#hide indicates that a pane should be hidden.
-
#icon ⇒ Wx::BitmapBundle
icon of the pane, may be invalid.
-
#initialize(*args) ⇒ AuiPaneInfo
constructor
A new instance of AuiPaneInfo.
-
#is_bottom_dockable ⇒ Boolean
(also: #bottom_dockable?)
#is_bottom_dockable returns true if the pane can be docked at the bottom of the managed frame.
-
#is_dockable ⇒ Boolean
(also: #dockable?)
Returns true if the pane can be docked at any side.
-
#is_docked ⇒ Boolean
(also: #docked?)
#is_docked returns true if the pane is currently docked.
-
#is_fixed ⇒ Boolean
(also: #fixed?)
#is_fixed returns true if the pane cannot be resized.
-
#is_floatable ⇒ Boolean
(also: #floatable?)
#is_floatable returns true if the pane can be undocked and displayed as a floating window.
-
#is_floating ⇒ Boolean
(also: #floating?)
#is_floating returns true if the pane is floating.
-
#is_left_dockable ⇒ Boolean
(also: #left_dockable?)
#is_left_dockable returns true if the pane can be docked on the left of the managed frame.
-
#is_movable ⇒ Boolean
(also: #movable?)
IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
-
#is_ok ⇒ Boolean
(also: #ok?)
#is_ok returns true if the AuiPaneInfo structure is valid.
-
#is_resizable ⇒ Boolean
(also: #resizable?)
#is_resizable returns true if the pane can be resized.
-
#is_right_dockable ⇒ Boolean
(also: #right_dockable?)
#is_right_dockable returns true if the pane can be docked on the right of the managed frame.
-
#is_shown ⇒ Boolean
(also: #shown?)
#is_shown returns true if the pane is currently shown.
-
#is_toolbar ⇒ Boolean
(also: #toolbar?)
#is_toolbar returns true if the pane contains a toolbar.
-
#is_top_dockable ⇒ Boolean
(also: #top_dockable?)
#is_top_dockable returns true if the pane can be docked at the top of the managed frame.
- #is_valid ⇒ Boolean (also: #valid?)
-
#layer ⇒ Integer
layer number (0 = innermost layer).
-
#left ⇒ Wx::AUI::AuiPaneInfo
#left sets the pane dock position to the left side of the frame.
-
#max_size ⇒ Wx::Size
maximum size the pane window can tolerate.
-
#min_size ⇒ Wx::Size
minimum size the pane window can tolerate.
-
#name ⇒ String
name of the pane.
-
#position ⇒ Integer
position inside the row (0 = first position).
-
#proportion ⇒ Integer
proportion while docked.
-
#proportion=(val) ⇒ void
proportion while docked.
-
#rect ⇒ Wx::Rect
current rectangle (populated by Wx::AUI).
-
#right ⇒ Wx::AUI::AuiPaneInfo
#right sets the pane dock position to the right side of the frame.
-
#row ⇒ Integer
row number on the docking bar (0 = first row).
-
#safe_set(source) ⇒ void
Write the safe parts of a PaneInfo object “source” into “this”.
-
#set_best_size(size) ⇒ Wx::AUI::AuiPaneInfo
(also: #best_size=)
#best_size sets the ideal size for the pane.
-
#set_bottom_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #bottom_dockable=)
bottom_dockable indicates whether a pane can be docked at the bottom of the frame.
-
#set_caption(c) ⇒ Wx::AUI::AuiPaneInfo
(also: #caption=)
#caption sets the caption of the pane.
-
#set_caption_visible(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #caption_visible=)
CaptionVisible indicates that a pane caption should be visible.
-
#set_close_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #close_button=)
close_button indicates that a close button should be drawn for the pane.
-
#set_destroy_on_close(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #destroy_on_close=)
destroy_on_close indicates whether a pane should be destroyed when it is closed.
-
#set_direction(direction) ⇒ Wx::AUI::AuiPaneInfo
(also: #direction=)
#direction determines the direction of the docked pane.
-
#set_dock_fixed(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #dock_fixed=)
dock_fixed causes the containing dock to have no resize sash.
-
#set_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #dockable=)
dockable specifies whether a frame can be docked or not.
-
#set_flag(flag, option_state) ⇒ Wx::AUI::AuiPaneInfo
#set_flag turns the property given by flag on or off with the option_state parameter.
-
#set_floatable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #floatable=)
floatable sets whether the user will be able to undock a pane and turn it into a floating window.
-
#set_floating_position(pos) ⇒ Wx::AUI::AuiPaneInfo
(also: #floating_position=)
#floating_position sets the position of the floating pane.
-
#set_floating_size(size) ⇒ Wx::AUI::AuiPaneInfo
(also: #floating_size=)
#floating_size sets the size of the floating pane.
-
#set_gripper(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #gripper=)
gripper indicates that a gripper should be drawn for the pane.
-
#set_gripper_top(attop = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #gripper_top=)
gripper_top indicates that a gripper should be drawn at the top of the pane.
-
#set_icon(b) ⇒ Wx::AUI::AuiPaneInfo
(also: #icon=)
#icon sets the icon of the pane.
-
#set_layer(layer) ⇒ Wx::AUI::AuiPaneInfo
(also: #layer=)
#layer determines the layer of the docked pane.
-
#set_left_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #left_dockable=)
left_dockable indicates whether a pane can be docked on the left of the frame.
-
#set_max_size(size) ⇒ Wx::AUI::AuiPaneInfo
(also: #max_size=)
#max_size sets the maximum size of the pane.
-
#set_maximize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #maximize_button=)
maximize_button indicates that a maximize button should be drawn for the pane.
-
#set_min_size(size) ⇒ Wx::AUI::AuiPaneInfo
(also: #min_size=)
#min_size sets the minimum size of the pane.
-
#set_minimize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #minimize_button=)
minimize_button indicates that a minimize button should be drawn for the pane.
-
#set_movable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #movable=)
Movable indicates whether a frame can be moved.
-
#set_name(n) ⇒ Wx::AUI::AuiPaneInfo
(also: #name=)
#name sets the name of the pane so it can be referenced in lookup functions.
-
#set_pane_border(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #pane_border=)
PaneBorder indicates that a border should be drawn for the pane.
-
#set_pin_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #pin_button=)
pin_button indicates that a pin button should be drawn for the pane.
-
#set_position(pos) ⇒ Wx::AUI::AuiPaneInfo
(also: #position=)
#position determines the position of the docked pane.
-
#set_resizable(resizable = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #resizable=)
resizable allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false.
-
#set_right_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #right_dockable=)
right_dockable indicates whether a pane can be docked on the right of the frame.
-
#set_row(row) ⇒ Wx::AUI::AuiPaneInfo
(also: #row=)
#row determines the row of the docked pane.
-
#set_top_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo
(also: #top_dockable=)
top_dockable indicates whether a pane can be docked at the top of the frame.
-
#set_window(w) ⇒ Wx::AUI::AuiPaneInfo
(also: #window=)
#window assigns the window pointer that the AuiPaneInfo should use.
-
#show(show = true) ⇒ Wx::AUI::AuiPaneInfo
#show indicates that a pane should be shown.
-
#state ⇒ Integer
a combination of PaneState values.
-
#toolbar_pane ⇒ Wx::AUI::AuiPaneInfo
#toolbar_pane specifies that the pane should adopt the default toolbar pane settings.
-
#top ⇒ Wx::AUI::AuiPaneInfo
#top sets the pane dock position to the top of the frame.
-
#window ⇒ Wx::Window
window that is in this pane.
Constructor Details
#initialize ⇒ Wx::AUI::AuiPaneInfo #initialize(c) ⇒ Wx::AUI::AuiPaneInfo
Returns a new instance of AuiPaneInfo.
254 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 254 def initialize(*args) end |
Instance Method Details
#best_size ⇒ Wx::Size
size that the layout engine will prefer
204 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 204 def best_size; end |
#bottom ⇒ Wx::AUI::AuiPaneInfo
#bottom sets the pane dock position to the bottom side of the frame.
This is the same thing as calling Direction(Wx::AUI::AuiManagerDock::AUI_DOCK_BOTTOM).
268 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 268 def bottom; end |
#caption ⇒ String
caption displayed on the window
150 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 150 def ; end |
#center ⇒ Wx::AUI::AuiPaneInfo
297 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 297 def center; end |
#center_pane ⇒ Wx::AUI::AuiPaneInfo
306 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 306 def center_pane; end |
#centre ⇒ Wx::AUI::AuiPaneInfo
#center 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(Wx::AUI::AuiManagerDock::AUI_DOCK_CENTRE).
294 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 294 def centre; end |
#centre_pane ⇒ Wx::AUI::AuiPaneInfo
#centre_pane 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.
303 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 303 def centre_pane; end |
#default_pane ⇒ Wx::AUI::AuiPaneInfo
#default_pane specifies that the pane should adopt the default pane settings.
316 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 316 def default_pane; end |
#direction ⇒ Integer
dock direction (top, bottom, left, right, center)
180 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 180 def direction; end |
#dock ⇒ Wx::AUI::AuiPaneInfo
338 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 338 def dock; end |
#fixed ⇒ Wx::AUI::AuiPaneInfo
360 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 360 def fixed; end |
#float ⇒ Wx::AUI::AuiPaneInfo
366 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 366 def float; end |
#floating_position ⇒ Wx::Point
position while floating
222 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 222 def floating_position; end |
#floating_size ⇒ Wx::Size
size while floating
228 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 228 def floating_size; end |
#frame ⇒ Wx::Frame
floating frame window that holds the pane
168 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 168 def frame; end |
#has_border ⇒ Boolean Also known as: has_border?
#has_border returns true if the pane displays a border.
400 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 400 def has_border; end |
#has_caption ⇒ Boolean Also known as:
#has_caption returns true if the pane displays a caption.
405 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 405 def ; end |
#has_close_button ⇒ Boolean Also known as:
#has_close_button returns true if the pane displays a button to close the pane.
410 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 410 def ; end |
#has_flag(flag) ⇒ Boolean Also known as: has_flag?
#has_flag returns true if the property specified by flag is active for the pane.
416 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 416 def has_flag(flag) end |
#has_gripper ⇒ Boolean Also known as: has_gripper?
#has_gripper returns true if the pane displays a gripper.
421 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 421 def has_gripper; end |
#has_gripper_top ⇒ Boolean Also known as: has_gripper_top?
#has_gripper returns true if the pane displays a gripper at the top.
426 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 426 def has_gripper_top; end |
#has_maximize_button ⇒ Boolean Also known as:
#has_maximize_button returns true if the pane displays a button to maximize the pane.
431 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 431 def ; end |
#has_minimize_button ⇒ Boolean Also known as:
#has_minimize_button returns true if the pane displays a button to minimize the pane.
436 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 436 def ; end |
#has_pin_button ⇒ Boolean Also known as:
#has_pin_button returns true if the pane displays a button to float the pane.
441 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 441 def ; end |
#hide ⇒ Wx::AUI::AuiPaneInfo
#hide indicates that a pane should be hidden.
446 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 446 def hide; end |
#icon ⇒ Wx::BitmapBundle
icon of the pane, may be invalid
156 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 156 def icon; end |
#is_bottom_dockable ⇒ Boolean Also known as: bottom_dockable?
#is_bottom_dockable returns true if the pane can be docked at the bottom of the managed frame.
461 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 461 def is_bottom_dockable; end |
#is_dockable ⇒ Boolean Also known as: dockable?
Returns true if the pane can be docked at any side.
472 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 472 def is_dockable; end |
#is_docked ⇒ Boolean Also known as: docked?
#is_docked returns true if the pane is currently docked.
477 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 477 def is_docked; end |
#is_fixed ⇒ Boolean Also known as: fixed?
#is_fixed returns true if the pane cannot be resized.
482 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 482 def is_fixed; end |
#is_floatable ⇒ Boolean Also known as: floatable?
#is_floatable returns true if the pane can be undocked and displayed as a floating window.
487 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 487 def is_floatable; end |
#is_floating ⇒ Boolean Also known as: floating?
#is_floating returns true if the pane is floating.
492 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 492 def is_floating; end |
#is_left_dockable ⇒ Boolean Also known as: left_dockable?
#is_left_dockable returns true if the pane can be docked on the left of the managed frame.
500 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 500 def is_left_dockable; end |
#is_movable ⇒ Boolean Also known as: movable?
IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
505 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 505 def is_movable; end |
#is_ok ⇒ Boolean Also known as: ok?
#is_ok returns true if the Wx::AUI::AuiPaneInfo structure is valid.
A pane structure is valid if it has an associated window.
512 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 512 def is_ok; end |
#is_resizable ⇒ Boolean Also known as: resizable?
#is_resizable returns true if the pane can be resized.
517 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 517 def is_resizable; end |
#is_right_dockable ⇒ Boolean Also known as: right_dockable?
#is_right_dockable returns true if the pane can be docked on the right of the managed frame.
525 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 525 def is_right_dockable; end |
#is_shown ⇒ Boolean Also known as: shown?
#is_shown returns true if the pane is currently shown.
530 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 530 def is_shown; end |
#is_toolbar ⇒ Boolean Also known as: toolbar?
#is_toolbar returns true if the pane contains a toolbar.
535 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 535 def ; end |
#is_top_dockable ⇒ Boolean Also known as: top_dockable?
#is_top_dockable returns true if the pane can be docked at the top of the managed frame.
543 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 543 def is_top_dockable; end |
#is_valid ⇒ Boolean Also known as: valid?
699 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 699 def is_valid; end |
#layer ⇒ Integer
layer number (0 = innermost layer)
186 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 186 def layer; end |
#left ⇒ Wx::AUI::AuiPaneInfo
#left sets the pane dock position to the left side of the frame.
This is the same thing as calling Direction(Wx::AUI::AuiManagerDock::AUI_DOCK_LEFT).
558 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 558 def left; end |
#max_size ⇒ Wx::Size
maximum size the pane window can tolerate
216 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 216 def max_size; end |
#min_size ⇒ Wx::Size
minimum size the pane window can tolerate
210 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 210 def min_size; end |
#name ⇒ String
name of the pane
144 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 144 def name; end |
#position ⇒ Integer
position inside the row (0 = first position)
198 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 198 def position; end |
#proportion ⇒ Integer
proportion while docked
234 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 234 def proportion; end |
#proportion=(val) ⇒ void
This method returns an undefined value.
proportion while docked
240 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 240 def proportion=(val); end |
#rect ⇒ Wx::Rect
current rectangle (populated by Wx::AUI)
246 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 246 def rect; end |
#right ⇒ Wx::AUI::AuiPaneInfo
#right sets the pane dock position to the right side of the frame.
This is the same thing as calling Direction(Wx::AUI::AuiManagerDock::AUI_DOCK_RIGHT).
636 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 636 def right; end |
#row ⇒ Integer
row number on the docking bar (0 = first row)
192 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 192 def row; end |
#safe_set(source) ⇒ void
This method returns an undefined value.
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.
This method is used when loading perspectives.
661 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 661 def safe_set(source) end |
#set_best_size(size) ⇒ Wx::AUI::AuiPaneInfo Also known as: best_size=
#best_size 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.
261 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 261 def set_best_size(size) end |
#set_bottom_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: bottom_dockable=
bottom_dockable indicates whether a pane can be docked at the bottom of the frame.
273 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 273 def set_bottom_dockable(b=true) end |
#set_caption(c) ⇒ Wx::AUI::AuiPaneInfo Also known as:
#caption sets the caption of the pane.
279 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 279 def (c) end |
#set_caption_visible(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as:
CaptionVisible indicates that a pane caption should be visible.
If false, no pane caption is drawn.
287 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 287 def (visible=true) end |
#set_close_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as:
close_button indicates that a close button should be drawn for the pane.
311 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 311 def (visible=true) end |
#set_destroy_on_close(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: destroy_on_close=
destroy_on_close 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.
323 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 323 def set_destroy_on_close(b=true) end |
#set_direction(direction) ⇒ Wx::AUI::AuiPaneInfo Also known as: direction=
#direction determines the direction of the docked pane.
It is functionally the same as calling #left, #right, #top or #bottom, except that docking direction may be specified programmatically via the parameter.
331 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 331 def set_direction(direction) end |
#set_dock_fixed(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: dock_fixed=
dock_fixed causes the containing dock to have no resize sash.
This is useful for creating panes that span the entire width or height of a dock, but should not be resizable in the other direction.
345 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 345 def set_dock_fixed(b=true) end |
#set_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: dockable=
dockable specifies whether a frame can be docked or not.
It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
353 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 353 def set_dockable(b=true) end |
#set_flag(flag, option_state) ⇒ Wx::AUI::AuiPaneInfo
#set_flag turns the property given by flag on or off with the option_state parameter.
667 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 667 def set_flag(flag, option_state) end |
#set_floatable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: floatable=
floatable sets whether the user will be able to undock a pane and turn it into a floating window.
371 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 371 def set_floatable(b=true) end |
#set_floating_position(pos) ⇒ Wx::AUI::AuiPaneInfo Also known as: floating_position=
#floating_position sets the position of the floating pane.
377 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 377 def set_floating_position(pos) end |
#set_floating_size(size) ⇒ Wx::AUI::AuiPaneInfo Also known as: floating_size=
#floating_size sets the size of the floating pane.
383 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 383 def set_floating_size(size) end |
#set_gripper(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: gripper=
gripper indicates that a gripper should be drawn for the pane.
389 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 389 def set_gripper(visible=true) end |
#set_gripper_top(attop = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: gripper_top=
gripper_top indicates that a gripper should be drawn at the top of the pane.
395 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 395 def set_gripper_top(attop=true) end |
#set_icon(b) ⇒ Wx::AUI::AuiPaneInfo Also known as: icon=
#icon sets the icon of the pane.
Notice that the height of the icon should be smaller than the value returned by Wx::AUI::AuiDockArt#get_metric(wxAUI_DOCKART_CAPTION_SIZE) to ensure that it appears correctly.
453 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 453 def set_icon(b) end |
#set_layer(layer) ⇒ Wx::AUI::AuiPaneInfo Also known as: layer=
#layer determines the layer of the docked pane.
The dock layer is similar to an onion, the inner-most layer being layer 0. Each shell moving in the outward direction has a higher layer number. This allows for more complex docking layout formation.
551 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 551 def set_layer(layer) end |
#set_left_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: left_dockable=
left_dockable indicates whether a pane can be docked on the left of the frame.
563 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 563 def set_left_dockable(b=true) end |
#set_max_size(size) ⇒ Wx::AUI::AuiPaneInfo Also known as: max_size=
#max_size sets the maximum size of the pane.
569 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 569 def set_max_size(size) end |
#set_maximize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as:
maximize_button indicates that a maximize button should be drawn for the pane.
575 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 575 def (visible=true) end |
#set_min_size(size) ⇒ Wx::AUI::AuiPaneInfo Also known as: min_size=
#min_size sets the minimum size of the pane.
Please note that this is only partially supported as of this writing.
583 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 583 def set_min_size(size) end |
#set_minimize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as:
minimize_button indicates that a minimize button should be drawn for the pane.
589 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 589 def (visible=true) end |
#set_movable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: movable=
Movable indicates whether a frame can be moved.
595 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 595 def set_movable(b=true) end |
#set_name(n) ⇒ Wx::AUI::AuiPaneInfo Also known as: name=
#name 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.
603 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 603 def set_name(n) end |
#set_pane_border(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: pane_border=
PaneBorder indicates that a border should be drawn for the pane.
609 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 609 def set_pane_border(visible=true) end |
#set_pin_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as:
pin_button indicates that a pin button should be drawn for the pane.
615 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 615 def (visible=true) end |
#set_position(pos) ⇒ Wx::AUI::AuiPaneInfo Also known as: position=
#position determines the position of the docked pane.
621 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 621 def set_position(pos) end |
#set_resizable(resizable = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: resizable=
resizable 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.
629 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 629 def set_resizable(resizable=true) end |
#set_right_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: right_dockable=
right_dockable indicates whether a pane can be docked on the right of the frame.
641 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 641 def set_right_dockable(b=true) end |
#set_row(row) ⇒ Wx::AUI::AuiPaneInfo Also known as: row=
#row determines the row of the docked pane.
647 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 647 def set_row(row) end |
#set_top_dockable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: top_dockable=
top_dockable indicates whether a pane can be docked at the top of the frame.
687 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 687 def set_top_dockable(b=true) end |
#set_window(w) ⇒ Wx::AUI::AuiPaneInfo Also known as: window=
#window assigns the window pointer that the Wx::AUI::AuiPaneInfo should use.
This normally does not need to be specified, as the window pointer is automatically assigned to the Wx::AUI::AuiPaneInfo structure as soon as it is added to the manager.
695 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 695 def set_window(w) end |
#show(show = true) ⇒ Wx::AUI::AuiPaneInfo
#show indicates that a pane should be shown.
672 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 672 def show(show=true) end |
#state ⇒ Integer
a combination of PaneState values
174 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 174 def state; end |
#toolbar_pane ⇒ Wx::AUI::AuiPaneInfo
#toolbar_pane specifies that the pane should adopt the default toolbar pane settings.
676 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 676 def ; end |
#top ⇒ Wx::AUI::AuiPaneInfo
#top sets the pane dock position to the top of the frame.
This is the same thing as calling Direction(Wx::AUI::AuiManagerDock::AUI_DOCK_TOP).
682 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 682 def top; end |
#window ⇒ Wx::Window
window that is in this pane
162 |
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 162 def window; end |