Class: Wx::AUI::AuiPaneInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/aui/aui_pane_info.rb

Overview

Note:

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)

See Also:

Requires:

  • USE_AUI

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::AUI::AuiPaneInfo #initialize(c) ⇒ Wx::AUI::AuiPaneInfo

Returns a new instance of AuiPaneInfo.

Overloads:



287
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 287

def initialize(*args) end

Instance Method Details

#best_size ⇒ Wx::Size

size that the layout engine will prefer

Returns:



237
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 237

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).

Returns:



301
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 301

def bottom; end

#caption ⇒ String

caption displayed on the window

Returns:

  • (String) 


183
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 183

def caption; end

#center ⇒ Wx::AUI::AuiPaneInfo

Returns:



330
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 330

def center; end

#center_pane ⇒ Wx::AUI::AuiPaneInfo

Returns:



339
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 339

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).

Returns:



327
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 327

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.

Returns:



336
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 336

def centre_pane; end

#default_pane ⇒ Wx::AUI::AuiPaneInfo

#default_pane specifies that the pane should adopt the default pane settings.

Returns:



349
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 349

def default_pane; end

#direction ⇒ Integer

dock direction (top, bottom, left, right, center)

Returns:

  • (Integer) 


213
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 213

def direction; end

#dock ⇒ Wx::AUI::AuiPaneInfo

#dock indicates that a pane should be docked.

It is the opposite of #float.

Returns:



371
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 371

def dock; end

#fixed ⇒ Wx::AUI::AuiPaneInfo

#fixed forces a pane to be fixed size so that it cannot be resized.

After calling #fixed, #is_fixed will return true.

Returns:



393
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 393

def fixed; end

#float ⇒ Wx::AUI::AuiPaneInfo

#float indicates that a pane should be floated.

It is the opposite of #dock.

Returns:



399
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 399

def float; end

#floating_client_size(size) ⇒ Wx::AUI::AuiPaneInfo #floating_client_size(x, y) ⇒ Wx::AUI::AuiPaneInfo

Overloads:



432
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 432

def floating_client_size(*args) end

#floating_position ⇒ Wx::Point

position while floating

Returns:



255
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 255

def floating_position; end

#floating_size ⇒ Wx::Size

size while floating

Returns:



261
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 261

def floating_size; end

#frame ⇒ Wx::Frame

floating frame window that holds the pane

Returns:



201
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 201

def frame; end

#has_border ⇒ Boolean Also known as: has_border?

#has_border returns true if the pane displays a border.

Returns:

  • (Boolean) 


448
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 448

def has_border; end

#has_caption ⇒ Boolean Also known as: has_caption?

#has_caption returns true if the pane displays a caption.

Returns:

  • (Boolean) 


453
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 453

def has_caption; end

#has_close_button ⇒ Boolean Also known as: has_close_button?

#has_close_button returns true if the pane displays a button to close the pane.

Returns:

  • (Boolean) 


458
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 458

def has_close_button; 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.

Parameters:

  • flag (Integer)

Returns:

  • (Boolean) 


464
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 464

def has_flag(flag) end

#has_gripper ⇒ Boolean Also known as: has_gripper?

#has_gripper returns true if the pane displays a gripper.

Returns:

  • (Boolean) 


469
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 469

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.

Returns:

  • (Boolean) 


474
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 474

def has_gripper_top; end

#has_maximize_button ⇒ Boolean Also known as: has_maximize_button?

#has_maximize_button returns true if the pane displays a button to maximize the pane.

Returns:

  • (Boolean) 


479
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 479

def has_maximize_button; end

#has_minimize_button ⇒ Boolean Also known as: has_minimize_button?

#has_minimize_button returns true if the pane displays a button to minimize the pane.

Returns:

  • (Boolean) 


484
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 484

def has_minimize_button; end

#has_pin_button ⇒ Boolean Also known as: has_pin_button?

#has_pin_button returns true if the pane displays a button to float the pane.

Returns:

  • (Boolean) 


489
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 489

def has_pin_button; end

#hide ⇒ Wx::AUI::AuiPaneInfo

#hide indicates that a pane should be hidden.

Returns:



494
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 494

def hide; end

#icon ⇒ Wx::BitmapBundle

icon of the pane, may be invalid

Returns:



189
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 189

def icon; end

#icon_min(b) ⇒ Wx::AUI::AuiPaneInfo

#icon_min sets the icon shown when the pane is minimized.

If minimized icon is not specified, the normal icon set by #icon is used instead, so this function should be only called if a different icon is desired for the minimized state or if you don’t want to show any icon in the title bar when the pane is shown normally. It is, of course, useless to call this function if the pane doesn’t have a minimize button.

Parameters:

Returns:

See Also:

  • minimize_button


511
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 511

def icon_min(b) 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.

Returns:

  • (Boolean)

See Also:



518
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 518

def is_bottom_dockable; end

#is_dockable ⇒ Boolean Also known as: dockable?

Returns true if the pane can be docked at any side.

Returns:

  • (Boolean)

See Also:



529
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 529

def is_dockable; end

#is_docked ⇒ Boolean Also known as: docked?

#is_docked returns true if the pane is currently docked.

Returns:

  • (Boolean) 


534
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 534

def is_docked; end

#is_fixed ⇒ Boolean Also known as: fixed?

#is_fixed returns true if the pane cannot be resized.

Returns:

  • (Boolean) 


539
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 539

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.

Returns:

  • (Boolean) 


544
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 544

def is_floatable; end

#is_floating ⇒ Boolean Also known as: floating?

#is_floating returns true if the pane is floating.

Returns:

  • (Boolean) 


549
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 549

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.

Returns:

  • (Boolean)

See Also:



557
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 557

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.

Returns:

  • (Boolean) 


562
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 562

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.

Returns:

  • (Boolean) 


569
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 569

def is_ok; end

#is_resizable ⇒ Boolean Also known as: resizable?

#is_resizable returns true if the pane can be resized.

Returns:

  • (Boolean) 


574
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 574

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.

Returns:

  • (Boolean)

See Also:



582
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 582

def is_right_dockable; end

#is_shown ⇒ Boolean Also known as: shown?

#is_shown returns true if the pane is currently shown.

Returns:

  • (Boolean) 


587
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 587

def is_shown; end

#is_toolbar ⇒ Boolean Also known as: toolbar?

#is_toolbar returns true if the pane contains a toolbar.

Returns:

  • (Boolean) 


592
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 592

def is_toolbar; 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.

Returns:

  • (Boolean)

See Also:



600
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 600

def is_top_dockable; end

#is_valid ⇒ Boolean Also known as: valid?

Returns:

  • (Boolean) 


761
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 761

def is_valid; end

#layer ⇒ Integer

layer number (0 = innermost layer)

Returns:

  • (Integer) 


219
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 219

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).

Returns:



615
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 615

def left; end

#max_size ⇒ Wx::Size

maximum size the pane window can tolerate

Returns:



249
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 249

def max_size; end

#min_size ⇒ Wx::Size

minimum size the pane window can tolerate

Returns:



243
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 243

def min_size; end

#name ⇒ String

name of the pane

Returns:

  • (String) 


177
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 177

def name; end

#position ⇒ Integer

position inside the row (0 = first position)

Returns:

  • (Integer) 


231
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 231

def position; end

#proportion ⇒ Integer

proportion while docked

Returns:

  • (Integer) 


267
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 267

def proportion; end

#proportion=(val) ⇒ void

This method returns an undefined value.

proportion while docked

Parameters:

  • val (Integer) 


273
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 273

def proportion=(val); end

#rect ⇒ Wx::Rect

current rectangle (populated by Wx::AUI)

Returns:



279
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 279

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).

Returns:



698
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 698

def right; end

#row ⇒ Integer

row number on the docking bar (0 = first row)

Returns:

  • (Integer) 


225
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 225

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.

Remark:

This method is used when loading perspectives.

Parameters:



723
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 723

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.

Parameters:

  • size (Array(Integer, Integer), Wx::Size)

Returns:



294
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 294

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



306
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 306

def set_bottom_dockable(b=true) end

#set_caption(c) ⇒ Wx::AUI::AuiPaneInfo Also known as: caption=

#caption sets the caption of the pane.

Parameters:

  • c (String)

Returns:



312
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 312

def set_caption(c) end

#set_caption_visible(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: caption_visible=

CaptionVisible indicates that a pane caption should be visible.

If false, no pane caption is drawn.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



320
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 320

def set_caption_visible(visible=true) end

#set_close_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: close_button=

close_button indicates that a close button should be drawn for the pane.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



344
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 344

def set_close_button(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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



356
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 356

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.

Parameters:

  • direction (Integer)

Returns:



364
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 364

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



378
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 378

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).

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



386
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 386

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.

Parameters:

  • flag (Integer)
  • option_state (Boolean)

Returns:



729
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 729

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



404
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 404

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.

Parameters:

Returns:



410
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 410

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.

#floating_client_size has precedence over this, i.e. this size is ignored if the floating client size is specified.

Parameters:

  • size (Array(Integer, Integer), Wx::Size)

Returns:



418
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 418

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.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



437
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 437

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.

Parameters:

  • attop (Boolean) (defaults to: true)

Returns:



443
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 443

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.

Parameters:

Returns:



501
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 501

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.

Parameters:

  • layer (Integer)

Returns:



608
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 608

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



620
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 620

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.

Parameters:

  • size (Array(Integer, Integer), Wx::Size)

Returns:



626
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 626

def set_max_size(size) end

#set_maximize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: maximize_button=

maximize_button indicates that a maximize button should be drawn for the pane.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



632
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 632

def set_maximize_button(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.

Parameters:

  • size (Array(Integer, Integer), Wx::Size)

Returns:



640
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 640

def set_min_size(size) end

#set_minimize_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: minimize_button=

minimize_button indicates that a minimize button should be drawn for the pane.

Pressing this button hides the pane and shows the minimized panes toolbar, allowing to show the pane again later, if it hadn’t been shown before. Note that when the toolbar containing the minimized panes is visible, all panes that have minimize_button enabled will show in it, even if they are currently shown.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:

See Also:



651
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 651

def set_minimize_button(visible=true) end

#set_movable(b = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: movable=

Movable indicates whether a frame can be moved.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



657
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 657

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.

Parameters:

  • n (String)

Returns:



665
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 665

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.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



671
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 671

def set_pane_border(visible=true) end

#set_pin_button(visible = true) ⇒ Wx::AUI::AuiPaneInfo Also known as: pin_button=

pin_button indicates that a pin button should be drawn for the pane.

Parameters:

  • visible (Boolean) (defaults to: true)

Returns:



677
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 677

def set_pin_button(visible=true) end

#set_position(pos) ⇒ Wx::AUI::AuiPaneInfo Also known as: position=

#position determines the position of the docked pane.

Parameters:

  • pos (Integer)

Returns:



683
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 683

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.

Parameters:

  • resizable (Boolean) (defaults to: true)

Returns:



691
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 691

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



703
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 703

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.

Parameters:

  • row (Integer)

Returns:



709
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 709

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.

Parameters:

  • b (Boolean) (defaults to: true)

Returns:



749
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 749

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.

Parameters:

Returns:



757
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 757

def set_window(w) end

#show(show = true) ⇒ Wx::AUI::AuiPaneInfo

#show indicates that a pane should be shown.

Parameters:

  • show (Boolean) (defaults to: true)

Returns:



734
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 734

def show(show=true) end

#state ⇒ Integer

a combination of PaneState values

Returns:

  • (Integer) 


207
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 207

def state; end

#toolbar_pane ⇒ Wx::AUI::AuiPaneInfo

#toolbar_pane specifies that the pane should adopt the default toolbar pane settings.

Returns:



738
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 738

def toolbar_pane; 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).

Returns:



744
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 744

def top; end

#window ⇒ Wx::Window

window that is in this pane

Returns:



195
 
# File 'lib/wx/doc/gen/aui/aui_pane_info.rb', line 195

def window; end