wxRuby Documentation Home

Wx::Panel

A panel is a window on which controls are placed. It is usually placed within a frame. It contains minimal extra functionality over and above its parent class Window; its main purpose is to be similar in appearance and functionality to a dialog, but with the flexibility of having any window as a parent.

Note: if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the TAB_TRAVERSAL style, which grabs some keypresses for use by child controls.

Derived from

Window

EvtHandler

Object

Window styles

There are no specific styles for this window.

See also window styles overview.

Remarks

By default, a panel has the same colouring as a dialog.

See also

Dialog

Methods

Panel.new

Panel.new(Window parent,  Integer id = $-1$, 
          Point pos = DEFAULT_POSITION, 
          Size size = DEFAULT_SIZE, 
          Integer style = TAB_TRAVERSAL, 
          String name = "panel")

Constructor.

Parameters

See also

Panel#create

destructor()

Destructor. Deletes any child windows before deleting the physical window.

Panel#create

Boolean create(Window parent,  Integer id, 
               Point pos = DEFAULT_POSITION, 
               Size size = DEFAULT_SIZE, 
               Integer style = TAB_TRAVERSAL, 
               String name = "panel")

Used for two-step panel construction. See Panel.new for details.

Panel#get_default_item

Window get_default_item()

Returns a pointer to the button which is the default for this window, or NULL. The default button is the one activated by pressing the Enter key.

Panel#init_dialog

init_dialog()

Sends a InitDialogEvent, which in turn transfers data to the dialog via validators.

See also

InitDialogEvent

Panel#on_sys_colour_changed

on_sys_colour_changed(SysColourChangedEvent event)

The default handler for EVT_SYS_COLOUR_CHANGED.

Parameters

Remarks

Changes the panel’s colour to conform to the current settings (Windows only). Add an event table entry for your panel class if you wish the behaviour to be different (such as keeping a user-defined background colour). If you do override this function, call Event::Skip to propagate the notification to child windows and controls.

See also

SysColourChangedEvent

Panel#set_default_item

set_default_item(Button btn)

Changes the default button for the panel.

See also

get_default_item

Panel#set_focus

set_focus()

Overrides Window#set_focus. This method uses the (undocumented) mix-in class ControlContainer which manages the focus and TAB logic for controls which usually have child controls. In practice, if you call this method and the control has at least one child window, the focus will be given to the child window.

See also

FocusEvent Window#set_focus

Panel#set_focus_ignoring_children

set_focus_ignoring_children()

In contrast to Panel#set_focus (see above) this will set the focus to the panel even of there are child windows in the panel. This is only rarely needed.

See also

FocusEvent Panel#set_focus

[This page automatically generated from the Textile source at Wed Sep 09 02:21:18 +0100 2009]