wxRuby Documentation Home

# Wx::MiniFrame

A miniframe is a frame with a small title bar. It is suitable for floating toolbars that must not
take up too much screen area.

## Derived from

Frame

Window

EvtHandler

Object

## Window styles

`ICONIZE` | Display the frame iconized (minimized) (Windows only).
`CAPTION` | Puts a caption on the frame.
`DEFAULT_FRAME_STYLE` | Defined as MINIMIZE_BOX * MAXIMIZE_BOX * THICK_FRAME * SYSTEM_MENU * CAPTION * CLOSE_BOX*.
`MINIMIZE` | Identical to ICONIZE.
`MINIMIZE_BOX` | Displays a minimize box on the frame (Windows and Motif only).
`MAXIMIZE` | Displays the frame maximized (Windows only).
`MAXIMIZE_BOX` | Displays a maximize box on the frame (Windows and Motif only).
`CLOSE_BOX` | Displays a close box on the frame.
`STAY_ON_TOP` | Stay on top of other windows (Windows only).
`SYSTEM_MENU` | Displays a system menu (Windows and Motif only).
`THICK_FRAME` | Displays a thick frame around the window (Windows and Motif only).
`TINY_CAPTION_HORIZ` | This style is obsolete andnot used any longer.
`TINY_CAPTION_VERT` | This style is obsolete and notused any longer.
`RESIZE_BORDER` | Displays a resizeable border around the window (Motif only;for Windows, it is implicit in THICK_FRAME).

See also window styles overview. Note that all the window styles
above are ignored under GTK and the mini frame cannot be resized by the user.

## Remarks

This class has miniframe functionality under Windows and GTK, i.e. the presence
of mini frame will not be noted in the task bar and focus behaviour is different.
On other platforms, it behaves like a normal frame.

## See also

MDIParentFrame, MDIChildFrame, Frame, Dialog

## Methods

- MiniFrame.new
- MiniFrame#create

### MiniFrame.new

MiniFrame.new(%(arg-type)Window% parent, Integer id, String title, Point pos = DEFAULT_POSITION, Size size = DEFAULT_SIZE, Integer style = DEFAULT_FRAME_STYLE, String name = “frame”)

Constructor, creating the window.

#### Parameters

- parent The window parent. This may be NULL. If it is non-NULL, the frame will
  always be displayed on top of the parent window on Windows.
- id The window identifier. It may take a value of -1 to indicate a default value.
- title The caption to be displayed on the frame’s title bar.
- pos The window position. A value of (-1, -1) indicates a default position, chosen by
  either the windowing system or Widgets, depending on platform.
- size The window size. A value of (-1, -1) indicates a default size, chosen by
  either the windowing system or Widgets, depending on platform.
- style The window style. See MiniFrame.
- name The name of the window. This parameter is used to associate a name with the item,
  allowing the application user to set Motif resource values for
  individual windows.

#### Remarks

The frame behaves like a normal frame on non-Windows platforms.

#### See also

MiniFrame#create

destructor()

Destructor. Destroys all child windows and menu bar if present.

### MiniFrame#create

Boolean create(%(arg-type)Window% parent, Integer id, String title, Point pos = DEFAULT_POSITION, Size size = DEFAULT_SIZE, Integer style = DEFAULT_FRAME_STYLE, String name = “frame”)

Used in two-step frame construction. See MiniFrame.new for further details.

[This page automatically generated from the Textile source at 2023-06-09 00:45:37 +0000]