FXDockBar.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                        D o c k B a r   W i d g e t                            *
*                                                                               *
*********************************************************************************
* Copyright (C) 2004,2006 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or                 *
* modify it under the terms of the GNU Lesser General Public                    *
* License as published by the Free Software Foundation; either                  *
* version 2.1 of the License, or (at your option) any later version.            *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
* Lesser General Public License for more details.                               *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public              *
* License along with this library; if not, write to the Free Software           *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
*********************************************************************************
* $Id: FXDockBar.h,v 1.24 2006/01/22 17:58:00 fox Exp $                         *
********************************************************************************/
#ifndef FXDOCKBAR_H
#define FXDOCKBAR_H

#ifndef FXPACKER_H
#include "FXPacker.h"
#endif

namespace FX {

class FXDockSite;


class FXAPI FXDockBar : public FXPacker {
  FXDECLARE(FXDockBar)
protected:
  FXComposite *drydock;         // Parent when docked
  FXComposite *wetdock;         // Parent when floating
  FXint        gripx;           // Grip offset x
  FXint        gripy;           // Grip offset y
  FXuchar      allowed;         // Where we're allowed to dock
protected:
  FXDockBar();
private:
  FXDockBar(const FXDockBar&);
  FXDockBar &operator=(const FXDockBar&);
public:
  long onCmdUndock(FXObject*,FXSelector,void*);
  long onUpdUndock(FXObject*,FXSelector,void*);
  long onCmdDockTop(FXObject*,FXSelector,void*);
  long onUpdDockTop(FXObject*,FXSelector,void*);
  long onCmdDockBottom(FXObject*,FXSelector,void*);
  long onUpdDockBottom(FXObject*,FXSelector,void*);
  long onCmdDockLeft(FXObject*,FXSelector,void*);
  long onUpdDockLeft(FXObject*,FXSelector,void*);
  long onCmdDockRight(FXObject*,FXSelector,void*);
  long onUpdDockRight(FXObject*,FXSelector,void*);
  long onUpdDockFlip(FXObject*,FXSelector,void*);
  long onBeginDragGrip(FXObject*,FXSelector,void*);
  long onEndDragGrip(FXObject*,FXSelector,void*);
  long onDraggedGrip(FXObject*,FXSelector,void*);
  long onPopupMenu(FXObject*,FXSelector,void*);
  long onDockTimer(FXObject*,FXSelector,void*);
public:
  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
    };
public:
  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:

  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 { return drydock; }

  FXComposite* getWetDock() const { return wetdock; }

  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){ allowed=allow; }

  FXuchar allowedSides() const { return allowed; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXDockBar();
  };

}

#endif

---

(C) 2002-2009 Niall Douglas. Some parts (C) to assorted authors.