fxruby 1.6.19 → 1.6.20

data/swig-interfaces/FXDockBar.i

@@ -0,0 +1,180 @@
+/***********************************************************************
+ * FXRuby -- the Ruby language bindings for the FOX GUI toolkit.
+ * Copyright (c) 2001 by J. Lyle Johnson. 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
+ *
+ * For further information please contact the author by e-mail
+ * at "lyle@lylejohnson.name".
+ ***********************************************************************/
+
+%rename("docked?")       FXDockBar::isDocked() const;
+%rename("insideDock?")   FXDockBar::insideDock(FXDockSite* docksite,FXint barx,FXint bary);
+%rename("dryDock=")      FXDockBar::setDryDock(FXComposite* dry);
+%rename("dryDock")       FXDockBar::getDryDock() const;
+%rename("wetDock=")      FXDockBar::setWetDock(FXComposite* wet);
+%rename("wetDock")       FXDockBar::getWetDock() const;
+%rename("allowedSides=") FXDockBar::allowedSides(FXuchar allow);
+
+/**
+* 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.
+*/
+class FXDockBar : public FXPacker {
+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();
+public:
+  long onCmdUndock(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdUndock(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onCmdDockTop(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdDockTop(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onCmdDockBottom(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdDockBottom(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onCmdDockLeft(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdDockLeft(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onCmdDockRight(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdDockRight(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onUpdDockFlip(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onBeginDragGrip(FXObject*,FXSelector,void* PTR_EVENT);
+  long onEndDragGrip(FXObject*,FXSelector,void* PTR_EVENT);
+  long onDraggedGrip(FXObject*,FXSelector,void* PTR_EVENT);
+  long onPopupMenu(FXObject*,FXSelector,void* PTR_EVENT);
+  long onDockTimer(FXObject*,FXSelector,void* PTR_DOCKSITE);  // FIXME
+public:
+  enum {
+    ID_DOCK_FLOAT=FXPacker::ID_LAST,    /// 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
+    };
+public:
+  enum {
+    ALLOW_NOWHERE=0,                                    /// Don't allow docking anywhere
+    ALLOW_TOP=1,                                        /// Docking at the top only
+    ALLOW_BOTTOM=2,                                     /// Docking at the bottom only
+    ALLOW_LEFT=4,                                       /// Docking at the left only
+    ALLOW_RIGHT=8,                                      /// Docking at the right only
+    ALLOW_HORIZONTAL=ALLOW_TOP|ALLOW_BOTTOM,            /// Docking at the top and bottom
+    ALLOW_VERTICAL=ALLOW_LEFT|ALLOW_RIGHT,              /// Docking at the left and right
+    ALLOW_EVERYWHERE=ALLOW_HORIZONTAL|ALLOW_VERTICAL    /// Docking can be everywhere
+    };
+public:
+
+  %extend {
+    /**
+    * 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.
+    */
+    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){
+      return new FXRbDockBar(p,q,opts,x,y,w,h,pl,pr,pt,pb,hs,vs);
+      }
+
+    /**
+    * Construct a non-floatable dock bar.
+    * The dock bar can not be undocked.
+    */
+    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){
+      return new FXRbDockBar(p,opts,x,y,w,h,pl,pr,pt,pb,hs,vs);
+      }
+  }
+
+  /// Return true if docked
+  FXbool isDocked() const;
+
+  /**
+   * Check if the dock bar would dock or undock if at locaton barx, bary.
+   */
+  FXbool insideDock(FXDockSite* docksite,FXint barx,FXint bary);
+
+  /**
+  * Set parent when docked.
+  * If it was docked, reparent under the new docking window.
+  */
+  void setDryDock(FXComposite* dry);
+
+  /**
+  * Set parent when floating.
+  * If it was undocked, then reparent under the new floating window.
+  */
+  void setWetDock(FXComposite* wet);
+
+  /// Return parent when docked
+  FXComposite* getDryDock() const;
+
+  /// Return parent when floating
+  FXComposite* getWetDock() const;
+
+  /// Search for dock against given side of main window
+  FXDockSite* findDockAtSide(FXuint side=LAYOUT_SIDE_TOP);
+
+  /// Search for dock close to coordinates rootx, rooty
+  FXDockSite* findDockNear(FXint rootx,FXint rooty);
+
+  /**
+  * 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.
+  */
+  void allowedSides(FXuchar allow);
+
+  /**
+  * Return set of sides where docking is allowed
+  */
+  FXuchar allowedSides() const;
+
+  /// Destroy
+  virtual ~FXDockBar();
+  };
+
+
+DECLARE_FXOBJECT_VIRTUALS(FXDockBar)
+DECLARE_FXID_VIRTUALS(FXDockBar)
+DECLARE_FXDRAWABLE_VIRTUALS(FXDockBar)
+DECLARE_FXWINDOW_VIRTUALS(FXDockBar)
+DECLARE_FXDOCKBAR_VIRTUALS(FXDockBar)
+
+%{
+static swig_type_info *FXDockBar_dynamic_cast(void **ptr) {
+    FXDockBar **ppDockBar = reinterpret_cast<FXDockBar **>(ptr);
+    FXToolBar *pToolBar=dynamic_cast<FXToolBar*>(*ppDockBar);
+    if(pToolBar){
+      *ptr=reinterpret_cast<void*>(pToolBar);
+      return SWIG_TypeQuery("FXToolBar *");
+      }
+    return 0;
+}
+%}
+
+DYNAMIC_CAST(SWIGTYPE_p_FXDockBar, FXDockBar_dynamic_cast);
+

data/swig-interfaces/FXDockHandler.i

@@ -0,0 +1,94 @@
+/***********************************************************************
+ * FXRuby -- the Ruby language bindings for the FOX GUI toolkit.
+ * Copyright (c) 2001-2009 by Lyle Johnson. 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
+ *
+ * For further information please contact the author by e-mail
+ * at "lyle@lylejohnson.name".
+ ***********************************************************************/
+
+%rename("helpText=") FXDockHandler::setHelpText(const FXString&);
+%rename("helpText")  FXDockHandler::getHelpText() const;
+%rename("tipText=")  FXDockHandler::setTipText(const FXString&);
+%rename("tipText")   FXDockHandler::getTipText() const;
+
+/**
+* The dock handler exists as a common base class for tool bar grip
+* and dock title.  
+*/
+class FXDockHandler : public FXFrame {
+protected:
+  FXString  tip;        // Tool tip
+  FXString  help;       // Help string
+protected:
+  FXDockHandler();
+private:
+  FXDockHandler(const FXDockHandler&);
+  FXDockHandler& operator=(const FXDockHandler&);
+public:
+  long onLeftBtnPress(FXObject*,FXSelector,void*);
+  long onLeftBtnRelease(FXObject*,FXSelector,void*);
+  long onMotion(FXObject*,FXSelector,void*);
+  long onKeyPress(FXObject*,FXSelector,void*);
+  long onKeyRelease(FXObject*,FXSelector,void*);
+  long onQueryTip(FXObject*,FXSelector,void*);
+  long onQueryHelp(FXObject*,FXSelector,void*);
+  long onCmdSetTip(FXObject*,FXSelector,void*);
+  long onCmdGetTip(FXObject*,FXSelector,void*);
+  long onCmdSetHelp(FXObject*,FXSelector,void*);
+  long onCmdGetHelp(FXObject*,FXSelector,void*);
+protected:
+  FXDockHandler(FXComposite* p,FXObject* tgt,FXSelector sel,FXuint opts,FXint x,FXint y,FXint w,FXint h,FXint pl,FXint pr,FXint pt,FXint pb);
+public:
+
+  /// Set the status line help text for grip
+  void setHelpText(const FXString& text);
+
+  /// Get the status line help text for grip
+  const FXString& getHelpText() const;
+
+  /// Set the tool tip message for the grip
+  void setTipText(const FXString& text);
+
+  /// Get the tool tip message for the grip
+  const FXString& getTipText() const;
+  };
+
+
+DECLARE_FXOBJECT_VIRTUALS(FXDockHandler)
+DECLARE_FXID_VIRTUALS(FXDockHandler)
+DECLARE_FXDRAWABLE_VIRTUALS(FXDockHandler)
+DECLARE_FXWINDOW_VIRTUALS(FXDockHandler)
+
+%{
+static swig_type_info *FXDockHandler_dynamic_cast(void **ptr) {
+    FXDockHandler **ppDockHandler = reinterpret_cast<FXDockHandler **>(ptr);
+    FXDockTitle *pDockTitle=dynamic_cast<FXDockTitle*>(*ppDockHandler);
+    if(pDockTitle){
+      *ptr=reinterpret_cast<void*>(pDockTitle);
+      return SWIG_TypeQuery("FXDockTitle *");
+      }
+    FXToolBarGrip *pToolBarGrip=dynamic_cast<FXToolBarGrip*>(*ppDockHandler);
+    if(pToolBarGrip){
+      *ptr=reinterpret_cast<void*>(pToolBarGrip);
+      return SWIG_TypeQuery("FXToolBarGrip *");
+      }
+    return 0;
+}
+%}
+
+DYNAMIC_CAST(SWIGTYPE_p_FXDockHandler, FXDockHandler_dynamic_cast);
+

data/swig-interfaces/FXDockSite.i

@@ -0,0 +1,91 @@
+/***********************************************************************
+ * FXRuby -- the Ruby language bindings for the FOX GUI toolkit.
+ * Copyright (c) 2001-2009 by Lyle Johnson. 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
+ *
+ * For further information please contact the author by e-mail
+ * at "lyle@lylejohnson.name".
+ ***********************************************************************/
+
+%rename("wrapGalleys=") FXDockSite::wrapGalleys(FXbool);
+%rename("wrapGalleys?") FXDockSite::wrapGalleys() const;
+
+/// Dock site options
+enum {
+  DOCKSITE_WRAP    = 0,           /// Dockbars are wrapped to another galley when not enough space on current galley
+  DOCKSITE_NO_WRAP = 0x00020000   /// Never wrap dockbars to another galley even if not enough space
+  };
+
+
+/**
+* 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.
+*/
+class FXDockSite : public FXPacker {
+protected:
+  FXDockSite(){}
+protected:
+  void moveVerBar(FXWindow* bar,FXWindow *begin,FXWindow* end,FXint bx,FXint by);
+  void moveHorBar(FXWindow* bar,FXWindow *begin,FXWindow* end,FXint bx,FXint by);
+  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;
+public:
+
+  %extend {
+    /**
+    * 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.
+    */
+    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){
+      return new FXRbDockSite(p,opts,x,y,w,h,pl,pr,pt,pb,hs,vs);
+      }
+  }
+  
+  /// Change wrap option
+  void wrapGalleys(FXbool wrap);
+
+  /// Get wrap option
+  FXbool wrapGalleys() const;
+
+  // Destroy
+  virtual ~FXDockSite();
+  };
+
+DECLARE_FXOBJECT_VIRTUALS(FXDockSite)
+DECLARE_FXID_VIRTUALS(FXDockSite)
+DECLARE_FXDRAWABLE_VIRTUALS(FXDockSite)
+DECLARE_FXWINDOW_VIRTUALS(FXDockSite)
+DECLARE_FXDOCKSITE_VIRTUALS(FXDockSite)
+

data/swig-interfaces/FXDockTitle.i

@@ -0,0 +1,91 @@
+/***********************************************************************
+ * FXRuby -- the Ruby language bindings for the FOX GUI toolkit.
+ * Copyright (c) 2001-2009 by Lyle Johnson. 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
+ *
+ * For further information please contact the author by e-mail
+ * at "lyle@lylejohnson.name".
+ ***********************************************************************/
+
+%rename("caption=")      FXDockTitle::setCaption(const FXString&);
+%rename("caption")       FXDockTitle::getCaption() const;
+%rename("font=")         FXDockTitle::setFont(FXFont*);
+%rename("font")          FXDockTitle::getFont() const;
+%rename("captionColor=") FXDockTitle::setCaptionColor(FXColor);
+%rename("captionColor")  FXDockTitle::getCaptionColor() const;
+%rename("justify=")      FXDockTitle::setJustify(FXuint);
+%rename("justify")       FXDockTitle::getJustify() const;
+
+/**
+* A dock title is used to move its container, a dock bar.
+* The dock title is also used simultaneously to provide a
+* caption above the dock bar.
+*/
+class FXDockTitle : public FXDockHandler {
+protected:
+  FXString  caption;            // Caption text
+  FXFont   *font;               // Caption font
+  FXColor   captionColor;       // Caption color
+protected:
+  FXDockTitle();
+public:
+  long onPaint(FXObject*,FXSelector,void* PTR_EVENT);
+  long onCmdSetValue(FXObject*,FXSelector,void*); // FIXME
+  long onCmdSetStringValue(FXObject*,FXSelector,void*); // FIXME
+  long onCmdGetStringValue(FXObject*,FXSelector,void*); // FIXME
+public:
+
+  %extend {
+    /// Construct dock bar title widget
+    FXDockTitle(FXComposite* p,const FXString& text,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=FRAME_NORMAL|JUSTIFY_CENTER_X|JUSTIFY_CENTER_Y,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=0,FXint pr=0,FXint pt=0,FXint pb=0){
+      return new FXRbDockTitle(p,text,tgt,sel,opts,x,y,w,h,pl,pr,pt,pb);
+      }
+  }
+  
+  /// Set the caption for the grip
+  void setCaption(const FXString& text);
+
+  /// Get the caption for the grip
+  FXString getCaption() const;
+
+  /// Set caption font
+  void setFont(FXFont *fnt);
+
+  /// Get caption font
+  FXFont* getFont() const;
+
+  /// Get the current caption color
+  FXColor getCaptionColor() const;
+
+  /// Set the current caption color
+  void setCaptionColor(FXColor clr);
+
+  /// Set the current justification mode.
+  void setJustify(FXuint mode);
+
+  /// Get the current justification mode.
+  FXuint getJustify() const;
+
+  /// Destroy
+  virtual ~FXDockTitle();
+  };
+
+
+DECLARE_FXOBJECT_VIRTUALS(FXDockTitle)
+DECLARE_FXID_VIRTUALS(FXDockTitle)
+DECLARE_FXDRAWABLE_VIRTUALS(FXDockTitle)
+DECLARE_FXWINDOW_VIRTUALS(FXDockTitle)
+