Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXDockSite Class Reference

The dock site widget is a widget where dock bars can be docked. More...

#include <FXDockSite.h>

Inheritance diagram for FX::FXDockSite:
FX::FXPacker FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

List of all members.

Public Member Functions

 FXDockSite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=0, FXint pr=0, FXint pt=0, FXint pb=0, FXint hs=0, FXint vs=0)
 Construct a toolbar dock layout manager.
virtual FXint getDefaultWidth ()
 Return default width.
virtual FXint getDefaultHeight ()
 Return default height.
virtual FXint getWidthForHeight (FXint h)
 For a vertically oriented dock site, this computes the total width of all the galleys based on any "wrapping" needed to fit the toolbars on a galley.
virtual FXint getHeightForWidth (FXint w)
 For a horizontally oriented dock site, this computes the total height of all the galleys based on any "wrapping" needed to fit the toolbars on a galley.
virtual void layout ()
 Perform layout.
virtual void resizeToolBar (FXDockBar *bar, FXint barx, FXint bary, FXint barw, FXint barh)
 Resize toolbar.
virtual void moveToolBar (FXDockBar *bar, FXint barx, FXint bary)
 Move tool bar, changing its options to suite the new position.
virtual void dockToolBar (FXDockBar *bar, FXWindow *other)
 The dock site is notified that the given bar has been added logically before the other window, and is to placed on a new galley all by itself.
virtual void dockToolBar (FXDockBar *bar, FXint barx, FXint bary)
 The dock site is informed that the given bar has been docked at the given coordinates.
virtual void undockToolBar (FXDockBar *bar)
 The dock site is informed that the given bar has been removed.
void wrapGalleys (FXbool wrap)
 Change wrap option.
FXbool wrapGalleys () const
 Get wrap option.
- Public Member Functions inherited from FX::FXPacker
long onPaint (FXObject *, FXSelector, void *)
long onFocusUp (FXObject *, FXSelector, void *)
long onFocusDown (FXObject *, FXSelector, void *)
long onFocusLeft (FXObject *, FXSelector, void *)
long onFocusRight (FXObject *, FXSelector, void *)
 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)
 Construct packer layout manager.
void setFrameStyle (FXuint style)
 Change frame style.
FXuint getFrameStyle () const
 Get current frame style.
void setPackingHints (FXuint ph)
 Change packing hints.
FXuint getPackingHints () const
 Return packing hints.
FXint getBorderWidth () const
 Get border width.
void setPadTop (FXint pt)
 Change top padding.
FXint getPadTop () const
 Get top interior padding.
void setPadBottom (FXint pb)
 Change bottom padding.
FXint getPadBottom () const
 Get bottom interior padding.
void setPadLeft (FXint pl)
 Change left padding.
FXint getPadLeft () const
 Get left interior padding.
void setPadRight (FXint pr)
 Change right padding.
FXint getPadRight () const
 Get right interior padding.
void setHiliteColor (FXColor clr)
 Change highlight color.
FXColor getHiliteColor () const
 Get highlight color.
void setShadowColor (FXColor clr)
 Change shadow color.
FXColor getShadowColor () const
 Get shadow color.
void setBorderColor (FXColor clr)
 Change border color.
FXColor getBorderColor () const
 Get border color.
void setBaseColor (FXColor clr)
 Change base gui color.
FXColor getBaseColor () const
 Get base gui color.
void setHSpacing (FXint hs)
 Change horizontal inter-child spacing.
FXint getHSpacing () const
 Return current horizontal inter-child spacing.
void setVSpacing (FXint vs)
 Change vertical inter-child spacing.
FXint getVSpacing () const
 Return current vertical inter-child spacing.
virtual void save (FXStream &store) const
 Save to stream.
virtual void load (FXStream &store)
 Load from stream.
- Public Member Functions inherited from FX::FXComposite
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onFocusNext (FXObject *, FXSelector, void *)
long onFocusPrev (FXObject *, FXSelector, void *)
long onCmdUpdate (FXObject *, FXSelector, void *)
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
virtual void create ()
 Create server-side resources.
virtual void detach ()
 Detach server-side resources.
virtual void destroy ()
 Destroy server-side resources.
FXint maxChildWidth () const
 Return the width of the widest child window.
FXint maxChildHeight () const
 Return the height of the tallest child window.
virtual FXbool isComposite () const
 Overrides this virtual function to return true.
virtual ~FXComposite ()
 Destructor.
- Public Member Functions inherited from FX::FXWindow
long onMap (FXObject *, FXSelector, void *)
long onUnmap (FXObject *, FXSelector, void *)
long onConfigure (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onEnter (FXObject *, FXSelector, void *)
long onLeave (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onMiddleBtnPress (FXObject *, FXSelector, void *)
long onMiddleBtnRelease (FXObject *, FXSelector, void *)
long onRightBtnPress (FXObject *, FXSelector, void *)
long onRightBtnRelease (FXObject *, FXSelector, void *)
long onSpaceBallMotion (FXObject *, FXSelector, void *)
long onSpaceBallButtonPress (FXObject *, FXSelector, void *)
long onSpaceBallButtonRelease (FXObject *, FXSelector, void *)
long onBeginDrag (FXObject *, FXSelector, void *)
long onEndDrag (FXObject *, FXSelector, void *)
long onDragged (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onDestroy (FXObject *, FXSelector, void *)
long onFocusSelf (FXObject *, FXSelector, void *)
long onFocusIn (FXObject *, FXSelector, void *)
long onFocusOut (FXObject *, FXSelector, void *)
long onSelectionLost (FXObject *, FXSelector, void *)
long onSelectionGained (FXObject *, FXSelector, void *)
long onSelectionRequest (FXObject *, FXSelector, void *)
long onClipboardLost (FXObject *, FXSelector, void *)
long onClipboardGained (FXObject *, FXSelector, void *)
long onClipboardRequest (FXObject *, FXSelector, void *)
long onDNDEnter (FXObject *, FXSelector, void *)
long onDNDLeave (FXObject *, FXSelector, void *)
long onDNDMotion (FXObject *, FXSelector, void *)
long onDNDDrop (FXObject *, FXSelector, void *)
long onDNDRequest (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
long onCmdShow (FXObject *, FXSelector, void *)
long onCmdHide (FXObject *, FXSelector, void *)
long onUpdToggleShown (FXObject *, FXSelector, void *)
long onCmdToggleShown (FXObject *, FXSelector, void *)
long onCmdRaise (FXObject *, FXSelector, void *)
long onCmdLower (FXObject *, FXSelector, void *)
long onCmdEnable (FXObject *, FXSelector, void *)
long onCmdDisable (FXObject *, FXSelector, void *)
long onUpdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdToggleEnabled (FXObject *, FXSelector, void *)
long onUpdYes (FXObject *, FXSelector, void *)
long onCmdDelete (FXObject *, FXSelector, void *)
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
FXWindowgetParent () const
 Return a pointer to the parent window.
FXWindowgetOwner () const
 Return a pointer to the owner window.
FXWindowgetShell () const
 Return a pointer to the shell window.
FXWindowgetRoot () const
 Return a pointer to the root window.
FXWindowgetNext () const
 Return a pointer to the next (sibling) window, if any.
FXWindowgetPrev () const
 Return a pointer to the previous (sibling) window , if any.
FXWindowgetFirst () const
 Return a pointer to this window's first child window , if any.
FXWindowgetLast () const
 Return a pointer to this window's last child window, if any.
FXWindowgetFocus () const
 Return a pointer to the currently focused child window.
virtual WindowClass getWindowClass () const
 Get window class.
void setKey (FXuint k)
 Change window key.
FXuint getKey () const
 Return window key.
FXWindowgetChildWithKey (FXuint k) const
 Return child window with given window key.
void setTarget (FXObject *t)
 Set the message target object for this window.
FXObjectgetTarget () const
 Get the message target object for this window, if any.
void setSelector (FXSelector sel)
 Set the message identifier for this window.
FXSelector getSelector () const
 Get the message identifier for this window.
FXint getX () const
 Get this window's x-coordinate, in the parent's coordinate system.
FXint getY () const
 Get this window's y-coordinate, in the parent's coordinate system.
void setX (FXint x)
 Set this window's x-coordinate, in the parent's coordinate system.
void setY (FXint y)
 Set this window's y-coordinate, in the parent's coordinate system.
void setWidth (FXint w)
 Set the window width; and flag the widget as being in need of layout by its parent.
void setHeight (FXint h)
 Set the window height; and flag the widget as being in need of layout by its parent.
void setLayoutHints (FXuint lout)
 Set layout hints for this window.
FXuint getLayoutHints () const
 Get layout hints for this window.
FXAccelTablegetAccelTable () const
 Return a pointer to the accelerator table.
void setAccelTable (FXAccelTable *acceltable)
 Set the accelerator table.
void addHotKey (FXHotKey code)
 Add a hot key.
void remHotKey (FXHotKey code)
 Remove a hot key.
void setHelpTag (const FXString &text)
 Change help tag for this widget.
const FXStringgetHelpTag () const
 Get the help tag for this widget.
FXbool isShell () const
 Return true if window is a shell window.
FXbool isOwnerOf (const FXWindow *window) const
 Return true if specified window is owned by this window.
FXbool isChildOf (const FXWindow *window) const
 Return true if specified window is ancestor of this window.
FXbool containsChild (const FXWindow *child) const
 Return true if this window contains child in its subtree.
FXWindowgetChildAt (FXint x, FXint y) const
 Return the child window at specified coordinates.
FXint numChildren () const
 Return the number of child windows for this window.
FXint indexOfChild (const FXWindow *window) const
 Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL.
FXWindowchildAtIndex (FXint index) const
 Return the child window at specified index, or NULL if the index is negative or out of range.
FXComposeContextgetComposeContext () const
 Return compose context.
void createComposeContext ()
 Create compose context.
void destroyComposeContext ()
 Destroy compose context.
FXbool cursorShown () const
 Is cursor shown.
void showCursor (FXbool flag=true)
 Show or hide the cursor.
void setDefaultCursor (FXCursor *cur)
 Set the default cursor for this window.
FXCursorgetDefaultCursor () const
 Return the default cursor for this window.
void setDragCursor (FXCursor *cur)
 Set the drag cursor for this window.
FXCursorgetDragCursor () const
 Return the drag cursor for this window.
FXbool getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 Return the cursor position and mouse button-state.
FXbool setCursorPosition (FXint x, FXint y)
 Warp the cursor to the new position.
FXbool isActive () const
 Return true if the window is active.
virtual FXbool canFocus () const
 Return true if this window is a control capable of receiving the focus.
FXbool hasFocus () const
 Return true if this window has the focus.
FXbool inFocusChain () const
 Return true if this window is in focus chain.
virtual void setFocus ()
 Move the focus to this window.
virtual void killFocus ()
 Remove the focus from this window.
virtual void changeFocus (FXWindow *child)
 Notification that focus moved to new child.
FXbool isDefault () const
 Return true if this is the default window.
virtual void setDefault (FXuchar flag=true)
 This changes the default window which responds to the Return key in a dialog.
FXWindowfindDefault () const
 Find default window among this window's children.
FXbool isInitial () const
 Return true if this is the initial default window.
void setInitial (FXbool flag=true)
 Make this window the initial default window.
FXWindowfindInitial () const
 Find inital default window among this window's children.
FXbool isEnabled () const
 Return true if this window is able to receive mouse and keyboard events.
virtual void enable ()
 Enable the window to receive mouse and keyboard events.
virtual void disable ()
 Disable the window from receiving mouse and keyboard events.
virtual void attach (FXID w)
 Attach foreign window handle to this window.
virtual void setShape (const FXRegion &region)
 Set window shape by means of region.
virtual void setShape (FXBitmap *bitmap)
 Set window shape by means of bitmap.
virtual void setShape (FXIcon *icon)
 Set window shape by means of icon.
virtual void clearShape ()
 Clear window shape.
virtual void raise ()
 Raise this window to the top of the stacking order.
virtual void lower ()
 Lower this window to the bottom of the stacking order.
virtual void move (FXint x, FXint y)
 Move the window immediately, in the parent's coordinate system.
virtual void resize (FXint w, FXint h)
 Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized.
virtual void position (FXint x, FXint y, FXint w, FXint h)
 Move and resize the window immediately, in the parent's coordinate system.
virtual void recalc ()
 Mark this window's layout as dirty for later layout.
void forceRefresh ()
 Generate a SEL_UPDATE message for the window and its children.
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 Reparent this window under new father before other.
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 Scroll rectangle x,y,w,h by a shift of dx,dy.
void update (FXint x, FXint y, FXint w, FXint h) const
 Mark the specified rectangle to be repainted later.
void update () const
 Mark the entire window to be repainted later.
void repaint (FXint x, FXint y, FXint w, FXint h) const
 Process any outstanding repaint messages immediately, for the given rectangle.
void repaint () const
 Process any outstanding repaint messages immediately.
FXbool grabbed () const
 Return true if the window has been grabbed.
void grab ()
 Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window.
void ungrab ()
 Release the mouse grab.
FXbool grabbedKeyboard () const
 Return true if active grab is in effect.
void grabKeyboard ()
 Grab keyboard device.
void ungrabKeyboard ()
 Ungrab keyboard device.
FXbool shown () const
 Return true if the window is shown.
virtual void show ()
 Show this window.
virtual void hide ()
 Hide this window.
FXbool underCursor () const
 Return true if the window is under the cursor.
FXbool hasSelection () const
 Return true if this window owns the primary selection.
FXbool acquireSelection (const FXDragType *types, FXuint numtypes)
 Try to acquire the primary selection, given a list of drag types.
FXbool releaseSelection ()
 Release the primary selection.
FXbool hasClipboard () const
 Return true if this window owns the clipboard.
FXbool acquireClipboard (const FXDragType *types, FXuint numtypes)
 Try to acquire the clipboard, given a list of drag types.
FXbool releaseClipboard ()
 Release the clipboard.
FXbool isDropEnabled () const
 Return true if this window is able to receive drops.
virtual void dropEnable ()
 Enable this window to receive drops.
virtual void dropDisable ()
 Disable this window from receiving drops.
FXbool isDragging () const
 Return true if a drag operaion has been initiated from this window.
FXbool beginDrag (const FXDragType *types, FXuint numtypes)
 Initiate a drag operation with a list of previously registered drag types.
FXbool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 When dragging, inform the drop-target of the new position and the drag action.
FXDragAction endDrag (FXbool drop=true)
 Terminate the drag operation with or without actually dropping the data Returns the action performed by the target.
FXbool isDropTarget () const
 Return true if this window is the target of a drop.
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=true) const
 When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle.
void clearDragRectangle () const
 When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves.
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 When being dragged over, indicate acceptance or rejection of the dragged data.
FXDragAction didAccept () const
 The target accepted our drop.
void dropFinished (FXDragAction action=DRAG_REJECT) const
 Sent by the drop target in response to SEL_DND_DROP.
FXbool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 When being dragged over, inquire the drag types which are being offered.
FXbool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 When being dragged over, return true if we are offered the given drag type.
FXDragAction inquireDNDAction () const
 When being dragged over, return the drag action.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 Set DND data; the array must be allocated with allocElms() and ownership is transferred to the system.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 Set DND data from string value.
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 Get DND data; the caller becomes the owner of the array and must free it with freeElms().
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 Get DND data into string value.
virtual FXbool contains (FXint parentx, FXint parenty) const
 Return true if window logically contains the given point.
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 Translate coordinates from fromwindow's coordinate space to this window's coordinate space.
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 Translate coordinates from this window's coordinate space to towindow's coordinate space.
virtual void setBackColor (FXColor clr)
 Set window background color.
FXColor getBackColor () const
 Get background color.
virtual FXbool doesSaveUnder () const
 Does save-unders.
virtual const FXchar * tr (const FXchar *text, const FXchar *hint=NULL, FXint count=-1) const FX_FORMAT(2)
 Translate message for localization; using the current FXTranslator, an attempt is made to translate the given message into the current language.
virtual ~FXWindow ()
 Destroy window.
- Public Member Functions inherited from FX::FXDrawable
FXVisualgetVisual () const
 Get the visual.
FXint getWidth () const
 Width of drawable.
FXint getHeight () const
 Height of drawable.
void setVisual (FXVisual *vis)
 Change visual.
virtual ~FXDrawable ()
 Cleanup.
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 Get application.
FXID id () const
 Get XID handle.
void setUserData (FXptr ptr)
 Set user data pointer.
FXptr getUserData () const
 Get user data pointer.
virtual ~FXId ()
 Destructor.
- Public Member Functions inherited from FX::FXObject
const FXchar * getClassName () const
 Get class name of some object.
FXbool isMemberOf (const FXMetaClass *metaclass) const
 Check if object is member of metaclass.
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 Try handle message safely, catching certain exceptions.
virtual long onDefault (FXObject *, FXSelector, void *)
 Called for unhandled messages.
virtual ~FXObject ()
 Virtual destructor.

Protected Types

enum  {
  DRAG_NONE = 0, DRAG_TOP = 1, DRAG_BOTTOM = 2, DRAG_LEFT = 4,
  DRAG_RIGHT = 8, DRAG_TOPLEFT = (DRAG_TOP|DRAG_LEFT), DRAG_TOPRIGHT = (DRAG_TOP|DRAG_RIGHT), DRAG_BOTTOMLEFT = (DRAG_BOTTOM|DRAG_LEFT),
  DRAG_BOTTOMRIGHT = (DRAG_BOTTOM|DRAG_RIGHT)
}

Protected Member Functions

void moveVerBar (FXWindow *&begin, FXWindow *&end, FXWindow *bar, FXint barx, FXint bary, FXint barw, FXint barh, FXbool hop)
void moveHorBar (FXWindow *&begin, FXWindow *&end, FXWindow *bar, FXint barx, FXint bary, FXint barw, FXint barh, FXbool hop)
void galleyOfHorzBar (FXWindow *bar, FXWindow *&begin, FXWindow *&end) const
void galleyOfVertBar (FXWindow *bar, FXWindow *&begin, FXWindow *&end) const
FXint galleyWidth (FXWindow *begin, FXWindow *&end, FXint space, FXint &require, FXint &expand) const
FXint galleyHeight (FXWindow *begin, FXWindow *&end, FXint space, FXint &require, FXint &expand) const
- Protected Member Functions inherited from FX::FXPacker
void drawBorderRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRidgeRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawGrooveRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawFocusRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawFrame (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXComposite
 FXComposite (FXApp *a, FXVisual *vis)
 FXComposite (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXWindow
 FXWindow (FXApp *a, FXVisual *vis)
 FXWindow (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
virtual FXbool doesOverrideRedirect () const
void addColormapWindows ()
void remColormapWindows ()
- Protected Member Functions inherited from FX::FXDrawable
 FXDrawable (FXApp *a, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXId
 FXId (FXApp *a)

Additional Inherited Members

- Protected Attributes inherited from FX::FXPacker
FXColor baseColor
FXColor hiliteColor
FXColor shadowColor
FXColor borderColor
FXint padtop
FXint padbottom
FXint padleft
FXint padright
FXint hspacing
FXint vspacing
FXint border

Detailed Description

The dock site widget is a widget where dock bars can be docked.

Dock site widgets are typically embedded inside the main window, placed against those sides where docking of toolbars is to be allowed. Dock bars placed inside a dock site are laid out in horizontal or vertical bands called galleys. A toolbar with the LAYOUT_DOCK_SAME hint is preferentially placed on the same galley as its previous sibling. A dock bar with the LAYOUT_DOCK_NEXT is always placed on the next galley. Each galley will have at least one dock bar shown in it. Several dock bars may be placed side-by-side inside one galley, unless there is insufficient room. If there is insufficient room to place another dock bar, that dock bar will be moved to the next galley, even though its LAYOUT_DOCK_NEXT option is not set. This implies that when the main window is resized and more room becomes available, it will jump back to its preferred galley. Within a galley, dock bars will be placed from left to right, at the given x and y coordinates, with the constraints that the dock bar will stay within the galley, and do not overlap each other. It is possible to use LAYOUT_FILL_X and/or LAYOUT_FILL_Y to stretch a toolbar to the available space on its galley. The galleys are oriented horizontally if the dock site is placed inside a top level window using LAYOUT_SIDE_TOP or LAYOUT_SIDE_BOTTOM, and vertically oriented if placed with LAYOUT_SIDE_LEFT or LAYOUT_SIDE_RIGHT.


Constructor & Destructor Documentation

FX::FXDockSite::FXDockSite ( FXComposite p,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0,
FXint  pl = 0,
FXint  pr = 0,
FXint  pt = 0,
FXint  pb = 0,
FXint  hs = 0,
FXint  vs = 0 
)

Construct a toolbar dock layout manager.

Passing LAYOUT_SIDE_TOP or LAYOUT_SIDE_BOTTOM causes the toolbar dock to be oriented horizontally. Passing LAYOUT_SIDE_LEFT or LAYOUT_SIDE_RIGHT causes it to be oriented vertically.


Member Function Documentation

virtual void FX::FXDockSite::dockToolBar ( FXDockBar bar,
FXWindow other 
)
virtual

The dock site is notified that the given bar has been added logically before the other window, and is to placed on a new galley all by itself.

The default implementation adjusts the layout options of the bars accordingly.

virtual void FX::FXDockSite::dockToolBar ( FXDockBar bar,
FXint  barx,
FXint  bary 
)
virtual

The dock site is informed that the given bar has been docked at the given coordinates.

The default implementation determines where to insert the newly docked bar and adjusts the layout options of the bars accordingly.

virtual FXint FX::FXDockSite::getDefaultHeight ( )
virtual

Return default height.

This is the height the toolbar dock would have if no toolbars need to be moved to other galleys than they would be logically placed.

Reimplemented from FX::FXPacker.

virtual FXint FX::FXDockSite::getDefaultWidth ( )
virtual

Return default width.

This is the width the toolbar dock would have if no toolbars need to be moved to other galleys than they would be logically placed.

Reimplemented from FX::FXPacker.

virtual void FX::FXDockSite::moveToolBar ( FXDockBar bar,
FXint  barx,
FXint  bary 
)
virtual

Move tool bar, changing its options to suite the new position.

Used by the toolbar dragging to rearrange the toolbars inside the toolbar dock.

virtual void FX::FXDockSite::undockToolBar ( FXDockBar bar)
virtual

The dock site is informed that the given bar has been removed.

In the default implementation, the dock site fixes the layout options of the remaining bars so they stay in the same place if possible.


The documentation for this class was generated from the following file:

Copyright © 1997-2016 Jeroen van der Zijp