fltk::DockWindow Class Reference

Inheritance diagram for fltk::DockWindow:

[legend]Collaboration diagram for fltk::DockWindow:

[legend]List of all members.

Public Member Functions
	DockWindow (int, int, int, int, const char *=0)
int	handle (int)
void	hide ()
Flags	state () const
virtual void	state (Flags a)
void	sizes (int, int, int, int, bool=false)
void	min_sizes (int, int, int, int)
void	holder (DockHolder *)
void	resizer (bool a)

---

Detailed Description

The base class for various dockable window and bar window. fltk::Window is not a parent class of fltk::DockWindow. Callbacks are done when a it is docked in or undocked from holder. The values for when() to control the behavior of callback are:

• fltk::WHEN_DOCK: Callback is done after it is docked.
• fltk::WHEN_UNDOCK: Callback is done after it is undocked.

Default value is (fltk::WHEN_DOCK | fltk::WHEN_UNDOCK)

---

Constructor & Destructor Documentation

DockWindow::DockWindow (  int  X, int  Y, int  W, int  H, const char *  l = 0 )

This constructor takes values for x(), y(), w(), h() and label(). When it is construct as a child of a holder, X, Y, W, H is used as position ans size hint for layout.

---

Member Function Documentation

int DockWindow::handle (  int  event  )  [virtual]

Calls send() on some or all of the children widgets. Reimplemented from fltk::Group. Reimplemented in fltk::ToolWindow.

void DockWindow::hide (   )

If visible() is true, turn it off. If visible_r() was true then send() a fltk::HIDE event, and redraw() the parent if necessary. Reimplemented from fltk::Widget.

void DockWindow::holder (  DockHolder *  dh  )

Sets top most holder where this dock window can dock.

void DockWindow::min_sizes (  int  W1, int  H1, int  W2, int  H2 )

Sets the minimum dimensions for both orientation. W1 and H1 used for horizontal minimum w() and h(). W2 and H2 used for vertical minimum w() and h().

void DockWindow::resizer (  bool  a  )  [inline]

Show a resize corner to the window if it is undocked.

void DockWindow::sizes (  int  W1, int  H1, int  W2, int  H2, bool  b = false )

Sets the dimensions for both orientation. W1 and H1 used for horizontal w() and h(). W2 and H2 used for vertical w() and h(). Call void min_sizes(int, int, int, int) with these values if b is true.

void DockWindow::state (  Flags  a  )  [virtual]

Sets the dock or undock state value. The value can be any of these following constants For docked with alignment DOCKED_TOP DOCKED_BOTTOM DOCKED_LEFT DOCKED_RIGHT DOCKED_CENTER For docked without alignment DOCKED_XY For not docked or undocked DOCKED_NONE Reimplemented in fltk::GripperBar.

Flags DockWindow::state (   )  const [inline]

Returns the dock or undock state value. See also: DockWindow::state(Flags) Reimplemented in fltk::GripperBar.

---

Tue Jun 27 02:20:03 2006. FLTK Dock is copyright © 2006 by MD. Z. Hossain