#include <FXDockBar.h>

Inheritance diagram for FX::FXDockBar:

Public Types
enum	{ ID_DOCK_FLOAT =FXPacker::ID_LAST, ID_DOCK_TOP, ID_DOCK_BOTTOM, ID_DOCK_LEFT, ID_DOCK_RIGHT, ID_DOCK_FLIP, ID_TOOLBARGRIP, ID_TIMER, ID_LAST }

enum	{ ALLOW_NOWHERE =0, ALLOW_TOP =1, ALLOW_BOTTOM =2, ALLOW_LEFT =4, ALLOW_RIGHT =8, ALLOW_HORIZONTAL =ALLOW_TOP\|ALLOW_BOTTOM, ALLOW_VERTICAL =ALLOW_LEFT\|ALLOW_RIGHT, ALLOW_EVERYWHERE =ALLOW_HORIZONTAL\|ALLOW_VERTICAL }

Public Types inherited from FX::FXWindow
enum	{ ID_NONE, ID_HIDE, ID_SHOW, ID_TOGGLESHOWN, ID_LOWER, ID_RAISE, ID_DELETE, ID_DISABLE, ID_ENABLE, ID_TOGGLEENABLED, ID_UNCHECK, ID_CHECK, ID_UNKNOWN, ID_UPDATE, ID_AUTOSCROLL, ID_TIPTIMER, ID_HSCROLLED, ID_VSCROLLED, ID_SETVALUE, ID_SETINTVALUE, ID_SETREALVALUE, ID_SETSTRINGVALUE, ID_SETICONVALUE, ID_SETINTRANGE, ID_SETREALRANGE, ID_GETINTVALUE, ID_GETREALVALUE, ID_GETSTRINGVALUE, ID_GETICONVALUE, ID_GETINTRANGE, ID_GETREALRANGE, ID_SETHELPSTRING, ID_GETHELPSTRING, ID_SETTIPSTRING, ID_GETTIPSTRING, ID_QUERY_MENU, ID_HOTKEY, ID_ACCEL, ID_UNPOST, ID_POST, ID_MDI_TILEHORIZONTAL, ID_MDI_TILEVERTICAL, ID_MDI_CASCADE, ID_MDI_MAXIMIZE, ID_MDI_MINIMIZE, ID_MDI_RESTORE, ID_MDI_CLOSE, ID_MDI_WINDOW, ID_MDI_MENUWINDOW, ID_MDI_MENUMINIMIZE, ID_MDI_MENURESTORE, ID_MDI_MENUCLOSE, ID_MDI_NEXT, ID_MDI_PREV, ID_LAST }

Public Member Functions
	FXDockBar (FXComposite p, FXComposite q, FXuint opts=LAYOUT_TOP\|LAYOUT_LEFT\|LAYOUT_FILL_X, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=3, FXint pr=3, FXint pt=2, FXint pb=2, FXint hs=DEFAULT_SPACING, FXint vs=DEFAULT_SPACING)

	FXDockBar (FXComposite *p, FXuint opts, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=2, FXint pr=3, FXint pt=3, FXint pb=2, FXint hs=DEFAULT_SPACING, FXint vs=DEFAULT_SPACING)

FXbool	isDocked () const

FXbool	insideDock (FXDockSite *docksite, FXint barx, FXint bary)

void	setDryDock (FXComposite *dry)

void	setWetDock (FXComposite *wet)

FXComposite *	getDryDock () const

FXComposite *	getWetDock () const

FXDockSite *	findDockAtSide (FXuint side=LAYOUT_SIDE_TOP)

FXDockSite *	findDockNear (FXint rootx, FXint rooty)

virtual void	dock (FXDockSite docksite, FXWindow before=NULL, FXbool notify=FALSE)

virtual void	dock (FXDockSite *docksite, FXint localx, FXint localy, FXbool notify)

virtual void	undock (FXint rootx, FXint rooty, FXbool notify=FALSE)

void	allowedSides (FXuchar allow)

FXuchar	allowedSides () const

virtual void	save (FXStream &store) const

virtual void	load (FXStream &store)

virtual	~FXDockBar ()

Public Member Functions inherited from FX::FXPacker
	FXPacker (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_SPACING, FXint pr=DEFAULT_SPACING, FXint pt=DEFAULT_SPACING, FXint pb=DEFAULT_SPACING, FXint hs=DEFAULT_SPACING, FXint vs=DEFAULT_SPACING)

virtual FXint	getDefaultWidth ()

virtual FXint	getDefaultHeight ()

virtual void	layout ()

void	setFrameStyle (FXuint style)

FXuint	getFrameStyle () const

void	setPackingHints (FXuint ph)

FXuint	getPackingHints () const

FXint	getBorderWidth () const

void	setPadTop (FXint pt)

FXint	getPadTop () const

void	setPadBottom (FXint pb)

FXint	getPadBottom () const

void	setPadLeft (FXint pl)

FXint	getPadLeft () const

void	setPadRight (FXint pr)

FXint	getPadRight () const

void	setHiliteColor (FXColor clr)

FXColor	getHiliteColor () const

void	setShadowColor (FXColor clr)

FXColor	getShadowColor () const

void	setBorderColor (FXColor clr)

FXColor	getBorderColor () const

void	setBaseColor (FXColor clr)

FXColor	getBaseColor () const

void	setHSpacing (FXint hs)

FXint	getHSpacing () const

void	setVSpacing (FXint vs)

FXint	getVSpacing () const

Public Member Functions inherited from FX::FXComposite
	FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)

virtual void	create ()

virtual void	detach ()

virtual void	destroy ()

FXint	maxChildWidth () const

FXint	maxChildHeight () const

virtual bool	isComposite () const

virtual	~FXComposite ()

Public Member Functions inherited from FX::FXWindow
	FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)

FXWindow *	getParent () const

FXWindow *	getOwner () const

FXWindow *	getShell () const

FXWindow *	getRoot () const

FXWindow *	getNext () const

FXWindow *	getPrev () const

FXWindow *	getFirst () const

FXWindow *	getLast () const

FXWindow *	getFocus () const

void	setKey (FXuint k)

FXuint	getKey () const

void	setTarget (FXObject *t)

FXObject *	getTarget () const

void	setSelector (FXSelector sel)

FXSelector	getSelector () const

FXint	getX () const

FXint	getY () const

virtual FXint	getWidthForHeight (FXint givenheight)

virtual FXint	getHeightForWidth (FXint givenwidth)

void	setX (FXint x)

void	setY (FXint y)

void	setWidth (FXint w)

void	setHeight (FXint h)

void	setLayoutHints (FXuint lout)

FXuint	getLayoutHints () const

FXAccelTable *	getAccelTable () const

void	setAccelTable (FXAccelTable *acceltable)

void	addHotKey (FXHotKey code)

void	remHotKey (FXHotKey code)

void	setHelpTag (const FXString &text)

const FXString &	getHelpTag () const

bool	isShell () const

bool	isOwnerOf (const FXWindow *window) const

bool	isChildOf (const FXWindow *window) const

bool	containsChild (const FXWindow *child) const

FXWindow *	getChildAt (FXint x, FXint y) const

FXint	numChildren () const

FXint	indexOfChild (const FXWindow *window) const

FXWindow *	childAtIndex (FXint index) const

FXComposeContext *	getComposeContext () const

void	createComposeContext ()

void	destroyComposeContext ()

void	setDefaultCursor (FXCursor *cur)

FXCursor *	getDefaultCursor () const

void	setDragCursor (FXCursor *cur)

FXCursor *	getDragCursor () const

FXint	getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const

FXint	setCursorPosition (FXint x, FXint y)

bool	isEnabled () const

bool	isActive () const

virtual bool	canFocus () const

bool	hasFocus () const

bool	inFocusChain () const

virtual void	setFocus ()

virtual void	killFocus ()

virtual void	changeFocus (FXWindow *child)

virtual void	setDefault (FXbool enable=TRUE)

bool	isDefault () const

void	setInitial (bool enable=true)

bool	isInitial () const

virtual void	enable ()

virtual void	disable ()

virtual void	attach (FXID w)

virtual void	setShape (const FXRegion &region)

virtual void	setShape (FXBitmap *bitmap)

virtual void	setShape (FXIcon *icon)

virtual void	clearShape ()

virtual void	raise ()

virtual void	lower ()

virtual void	move (FXint x, FXint y)

virtual void	resize (FXint w, FXint h)

virtual void	position (FXint x, FXint y, FXint w, FXint h)

virtual void	recalc ()

void	forceRefresh ()

virtual void	reparent (FXWindow father, FXWindow other=NULL)

void	scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const

void	update (FXint x, FXint y, FXint w, FXint h) const

void	update () const

void	repaint (FXint x, FXint y, FXint w, FXint h) const

void	repaint () const

void	grab ()

void	ungrab ()

bool	grabbed () const

void	grabKeyboard ()

void	ungrabKeyboard ()

bool	grabbedKeyboard () const

virtual void	show ()

virtual void	hide ()

bool	shown () const

bool	underCursor () const

bool	hasSelection () const

bool	acquireSelection (const FXDragType *types, FXuint numtypes)

bool	releaseSelection ()

bool	hasClipboard () const

bool	acquireClipboard (const FXDragType *types, FXuint numtypes)

bool	releaseClipboard ()

virtual void	dropEnable ()

virtual void	dropDisable ()

bool	isDropEnabled () const

bool	isDragging () const

bool	beginDrag (const FXDragType *types, FXuint numtypes)

bool	handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)

FXDragAction	endDrag (bool drop=true)

bool	isDropTarget () const

void	setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const

void	clearDragRectangle () const

void	acceptDrop (FXDragAction action=DRAG_ACCEPT) const

FXDragAction	didAccept () const

void	dropFinished (FXDragAction action=DRAG_REJECT) const

bool	inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const

bool	offeredDNDType (FXDNDOrigin origin, FXDragType type) const

FXDragAction	inquireDNDAction () const

bool	setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const

bool	setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const

bool	getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const

bool	getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const

virtual bool	contains (FXint parentx, FXint parenty) const

void	translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const

void	translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const

virtual void	setBackColor (FXColor clr)

FXColor	getBackColor () const

virtual bool	doesSaveUnder () const

virtual const FXchar *	tr (const FXchar message, const FXchar hint=NULL) const

virtual	~FXWindow ()

Public Member Functions inherited from FX::FXDrawable
FXint	getWidth () const

FXint	getHeight () const

FXVisual *	getVisual () const

void	setVisual (FXVisual *vis)

virtual	~FXDrawable ()

Public Member Functions inherited from FX::FXId
FXApp *	getApp () const

FXID	id () const

void	setUserData (void *ptr)

void *	getUserData () const

virtual	~FXId ()

Public Member Functions inherited from FX::FXObject
virtual long	onDefault (FXObject , FXSelector, void )

const FXchar *	getClassName () const

bool	isMemberOf (const FXMetaClass *metaclass) const

virtual long	tryHandle (FXObject sender, FXSelector sel, void ptr)

virtual	~FXObject ()

Additional Inherited Members
Static Public Member Functions inherited from FX::FXWindow
static FXWindow *	commonAncestor (FXWindow a, FXWindow b)

static bool	before (const FXWindow a, const FXWindow b)

static bool	after (const FXWindow a, const FXWindow b)

Static Public Attributes inherited from FX::FXWindow
static FXDragType	octetType

static FXDragType	deleteType

static FXDragType	textType

static FXDragType	utf8Type

static FXDragType	utf16Type

static FXDragType	colorType

static FXDragType	urilistType

static const FXDragType	stringType

static const FXDragType	imageType

static const FXchar	octetTypeName []

static const FXchar	deleteTypeName []

static const FXchar	textTypeName []

static const FXchar	colorTypeName []

static const FXchar	urilistTypeName []

static const FXchar	utf8TypeName []

static const FXchar	utf16TypeName []

Detailed Description

A dock bar widget can be docked inside a dock site widget, or floated around freely.

Users can move, undock, and dock the dock bar widget by means of a handle such as a tool bar grip. When docking, the dock bar sends a SEL_DOCKED message to its target; when undocking, it sends a SEL_FLOATED message. In either case the dock site involved is passed in the void* pointer argument of the message.

Member Enumeration Documentation

anonymous enum

Enumerator
ID_DOCK_FLOAT	Undock the dock bar.
ID_DOCK_TOP	Dock on the top.
ID_DOCK_BOTTOM	Dock on the bottom.
ID_DOCK_LEFT	Dock on the left.
ID_DOCK_RIGHT	Dock on the right.
ID_DOCK_FLIP	Flip orientation.
ID_TOOLBARGRIP	Tool bar grip.
ID_TIMER
ID_LAST

anonymous enum

Enumerator
ALLOW_NOWHERE	Don't allow docking anywhere.
ALLOW_TOP	Docking at the top only.
ALLOW_BOTTOM	Docking at the bottom only.
ALLOW_LEFT	Docking at the left only.
ALLOW_RIGHT	Docking at the right only.
ALLOW_HORIZONTAL	Docking at the top and bottom.
ALLOW_VERTICAL	Docking at the left and right.
ALLOW_EVERYWHERE	Docking can be everywhere.

Constructor & Destructor Documentation

FX::FXDockBar::FXDockBar	(	FXComposite *	p,
		FXComposite *	q,
		FXuint	opts = `LAYOUT_TOP\|LAYOUT_LEFT\|LAYOUT_FILL_X`,
		FXint	x = `0`,
		FXint	y = `0`,
		FXint	w = `0`,
		FXint	h = `0`,
		FXint	pl = `3`,
		FXint	pr = `3`,
		FXint	pt = `2`,
		FXint	pb = `2`,
		FXint	hs = `DEFAULT_SPACING`,
		FXint	vs = `DEFAULT_SPACING`
	)

Construct a floatable dock bar, with a default parent p and an alternate parent q.

To allow docking and dragging the default parent p must be of type FXDockSite, and the alternate parent q must be of type FXToolBarShell. Normally, the dock bar is docked under a window p of type FXDockSite. When floated, the toolbar can be docked under window q, which is usually an kind of FXToolBarShell window.

FX::FXDockBar::FXDockBar	(	FXComposite *	p,
		FXuint	opts,
		FXint	x = `0`,
		FXint	y = `0`,
		FXint	w = `0`,
		FXint	h = `0`,
		FXint	pl = `2`,
		FXint	pr = `3`,
		FXint	pt = `3`,
		FXint	pb = `2`,
		FXint	hs = `DEFAULT_SPACING`,
		FXint	vs = `DEFAULT_SPACING`
	)

Construct a non-floatable dock bar.

The dock bar can not be undocked.

virtual FX::FXDockBar::~FXDockBar ( )

virtual

Destroy.

Member Function Documentation

FXbool FX::FXDockBar::isDocked ( ) const

Return true if docked.

FXbool FX::FXDockBar::insideDock	(	FXDockSite *	docksite,
		FXint	barx,
		FXint	bary
	)

Check if the dock bar would dock or undock if at locaton barx, bary.

void FX::FXDockBar::setDryDock ( FXComposite * dry )

Set parent when docked.

If it was docked, reparent under the new docking window.

void FX::FXDockBar::setWetDock ( FXComposite * wet )

Set parent when floating.

If it was undocked, then reparent under the new floating window.

FXComposite* FX::FXDockBar::getDryDock ( ) const

inline

Return parent when docked.

FXComposite* FX::FXDockBar::getWetDock ( ) const

inline

Return parent when floating.

FXDockSite* FX::FXDockBar::findDockAtSide ( FXuint side = LAYOUT_SIDE_TOP )

Search for dock against given side of main window.

FXDockSite* FX::FXDockBar::findDockNear	(	FXint	rootx,
		FXint	rooty
	)

Search for dock close to coordinates rootx, rooty.

virtual void FX::FXDockBar::dock	(	FXDockSite *	docksite,
		FXWindow *	before = `NULL`,
		FXbool	notify = `FALSE`
	)

virtual

Dock the bar against the given side, after some other widget.

However, if after is -1, it will be docked as the innermost bar just before the work-area, while if after is 0, if will be docked as the outermost bar.

Reimplemented in FX::FXToolBar.

virtual void FX::FXDockBar::dock	(	FXDockSite *	docksite,
		FXint	localx,
		FXint	localy,
		FXbool	notify
	)

virtual

Dock the bar against the given side, near the given position relative to the toolbar dock's origin.

Reimplemented in FX::FXToolBar.

virtual void FX::FXDockBar::undock	(	FXint	rootx,
		FXint	rooty,
		FXbool	notify = `FALSE`
	)

virtual

Undock or float the bar.

The initial position of the wet dock is a few pixels below and to the right of the original docked position.

void FX::FXDockBar::allowedSides ( FXuchar allow )

inline

Change set of sides (a combination of ALLOW_TOP, ALLOW_LEFT, etc.), where docking is allowed.

The default is to allow docking on all sides.

FXuchar FX::FXDockBar::allowedSides ( ) const

inline

Return set of sides where docking is allowed.

virtual void FX::FXDockBar::save ( FXStream & store ) const

virtual

Save toolbar to a stream.

Reimplemented from FX::FXPacker.

virtual void FX::FXDockBar::load ( FXStream & store )

virtual

Load toolbar from a stream.

Reimplemented from FX::FXPacker.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation