fxruby 1.6.19 → 1.6.20

data/swig-interfaces/FXRuler.i

@@ -0,0 +1,245 @@
+/***********************************************************************
+ * 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".
+ ***********************************************************************/
+
+/// Ruler options
+enum {
+  RULER_NORMAL       = 0,                                   /// Default appearance (default)
+  RULER_HORIZONTAL   = 0,                                   /// Ruler is horizontal (default)
+  RULER_VERTICAL     = 0x00008000,                          /// Ruler is vertical
+  RULER_TICKS_OFF    = 0,                                   /// Tick marks off (default)
+  RULER_TICKS_TOP    = 0x00010000,                          /// Ticks on the top (if horizontal)
+  RULER_TICKS_BOTTOM = 0x00020000,                          /// Ticks on the bottom (if horizontal)
+  RULER_TICKS_LEFT   = RULER_TICKS_TOP,                     /// Ticks on the left (if vertical)
+  RULER_TICKS_RIGHT  = RULER_TICKS_BOTTOM,                  /// Ticks on the right (if vertical)
+  RULER_TICKS_CENTER = RULER_TICKS_TOP|RULER_TICKS_BOTTOM,  /// Tickmarks centered
+  RULER_NUMBERS      = 0x00040000,                          /// Show numbers
+  RULER_ARROW        = 0x00080000,                          /// Draw small arrow for cursor position
+  RULER_MARKERS      = 0x00100000,                          /// Draw markers for indentation settings
+  RULER_METRIC       = 0,                                   /// Metric subdivision (default)
+  RULER_ENGLISH       = 0x00200000,                             /// English subdivision
+  RULER_MARGIN_ADJUST = 0x00400000,                             /// Allow margin adjustment
+  RULER_ALIGN_CENTER  = 0,                                      /// Center document horizontally
+  RULER_ALIGN_LEFT    = 0x00800000,                             /// Align document to the left
+  RULER_ALIGN_RIGHT   = 0x01000000,                             /// Align document to the right
+  RULER_ALIGN_TOP     = RULER_ALIGN_LEFT,                       /// Align document to the top
+  RULER_ALIGN_BOTTOM  = RULER_ALIGN_RIGHT,                      /// Align document to the bottom
+  RULER_ALIGN_STRETCH = RULER_ALIGN_LEFT|RULER_ALIGN_RIGHT,     /// Stretch document to fit horizontally
+  RULER_ALIGN_NORMAL  = RULER_ALIGN_CENTER                      /// Normally, document is centered both ways
+  };
+
+
+class FXFont;
+
+%rename("documentUpper") FXRuler::getDocumentUpper() const;
+%rename("documentLower") FXRuler::getDocumentLower() const;
+
+/**
+* The Ruler widget is placed alongside a document to measure position
+* and size of entities within the document.
+*/
+class FXRuler : public FXFrame {
+protected:
+  FXFont  *font;                // Font for numbers
+  FXint    documentSize;        // Size of document
+  FXint    edgeSpacing;         // Edge spacing around document
+  FXint    marginLower;         // Lower margin
+  FXint    marginUpper;         // Upper margin
+  FXint    indentFirst;         // First line paragraph indent
+  FXint    indentLower;         // Lower paragraph indent
+  FXint    indentUpper;         // Upper paragraph indent
+  FXdouble pixelPerTick;        // Number of pixels per tick increment
+  FXint    numberTicks;         // Tick increments between numbers
+  FXint    majorTicks;          // Tick increments between major ticks
+  FXint    mediumTicks;         // Tick increments between medium ticks
+  FXint    tinyTicks;           // Tick increments between tiny ticks
+  FXint    arrowPos;            // Arrow position
+  FXColor  textColor;           // Color for numbers and ticks
+  FXint    shift;               // Left edge of content
+  FXint    pos;                 // Scroll position
+  FXint    off;                 // Offset item was grabbed
+  FXString tip;                 // Tooltip text
+  FXString help;                // Help text
+  FXuchar  mode;                // Mode widget is in
+protected:
+  FXRuler();
+  FXint picked(FXint x,FXint y);
+  void drawLeftArrow(FXDCWindow& dc,FXint x,FXint y);
+  void drawRightArrow(FXDCWindow& dc,FXint x,FXint y);
+  void drawUpArrow(FXDCWindow& dc,FXint x,FXint y);
+  void drawDownArrow(FXDCWindow& dc,FXint x,FXint y);
+  void drawLeftMarker(FXDCWindow& dc,FXint x,FXint y);
+  void drawRightMarker(FXDCWindow& dc,FXint x,FXint y);
+  void drawUpMarker(FXDCWindow& dc,FXint x,FXint y);
+  void drawDownMarker(FXDCWindow& dc,FXint x,FXint y);
+protected:
+  enum{
+    MOUSE_NONE,         // No mouse operation
+    MOUSE_MARG_LOWER,   // Drag lower margin
+    MOUSE_MARG_UPPER,   // Drag upper margin
+    MOUSE_PARA_FIRST,   // Drag first indent
+    MOUSE_PARA_LOWER,   // Drag lower indent
+    MOUSE_PARA_UPPER    // Drag upper indent
+    };
+private:
+  FXRuler(const FXRuler&);
+  FXRuler &operator=(const FXRuler&);
+public:
+  long onPaint(FXObject*,FXSelector,void* PTR_EVENT);
+  long onLeftBtnPress(FXObject*,FXSelector,void* PTR_EVENT);
+  long onLeftBtnRelease(FXObject*,FXSelector,void* PTR_EVENT);
+  long onMotion(FXObject*,FXSelector,void* PTR_EVENT);
+  long onCmdSetValue(FXObject*,FXSelector,void*); // FIXME
+  long onCmdSetIntValue(FXObject*,FXSelector,void*); // FIXME
+  long onCmdGetIntValue(FXObject*,FXSelector,void*); // FIXME
+  long onCmdSetHelp(FXObject*,FXSelector,void* PTR_STRING);
+  long onCmdGetHelp(FXObject*,FXSelector,void* PTR_IGNORE); // FIXME
+  long onCmdSetTip(FXObject*,FXSelector,void* PTR_STRING);
+  long onCmdGetTip(FXObject*,FXSelector,void* PTR_IGNORE); // FIXME
+  long onQueryHelp(FXObject*,FXSelector,void* PTR_IGNORE);
+  long onQueryTip(FXObject*,FXSelector,void* PTR_IGNORE);
+public:
+  enum {
+    ID_ARROW=FXFrame::ID_LAST,
+    ID_LAST
+    };
+public:
+  %extend {
+    /// Construct label with given text and icon
+    FXRuler(FXComposite* p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=RULER_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=DEFAULT_PAD,FXint pr=DEFAULT_PAD,FXint pt=DEFAULT_PAD,FXint pb=DEFAULT_PAD){
+      return new FXRbRuler(p,tgt,sel,opts,x,y,w,h,pl,pr,pt,pb);
+      }
+    }
+
+  /// Set the current position
+  void setPosition(FXint pos,FXbool notify=FALSE);
+
+  /// Return the current position
+  FXint getPosition() const;
+
+  /// Change/return content size
+  void setContentSize(FXint size,FXbool notify=FALSE);
+  FXint getContentSize() const;
+
+  /// Get lower edge of document
+  FXint getDocumentLower() const;
+
+  /// Get upper edge of document
+  FXint getDocumentUpper() const;
+
+  /// Change/return document size
+  void setDocumentSize(FXint size,FXbool notify=FALSE);
+  FXint getDocumentSize() const;
+
+  /// Change/return document edge spacing
+  void setEdgeSpacing(FXint space,FXbool notify=FALSE);
+  FXint getEdgeSpacing() const;
+
+  /// Change/return lower document margin
+  void setMarginLower(FXint mgn,FXbool notify=FALSE);
+  FXint getMarginLower() const;
+
+  /// Change/return upper document margin
+  void setMarginUpper(FXint mgn,FXbool notify=FALSE);
+  FXint getMarginUpper() const;
+
+  /// Change/return first line indent
+  void setIndentFirst(FXint ind,FXbool notify=FALSE);
+  FXint getIndentFirst() const;
+
+  /// Change/return lower indent
+  void setIndentLower(FXint ind,FXbool notify=FALSE);
+  FXint getIndentLower() const;
+
+  /// Change/return upper indent
+  void setIndentUpper(FXint ind,FXbool notify=FALSE);
+  FXint getIndentUpper() const;
+
+  /// Change/return document number placement
+  void setNumberTicks(FXint ticks,FXbool notify=FALSE);
+  FXint getNumberTicks() const;
+
+  /// Change/return document major ticks
+  void setMajorTicks(FXint ticks,FXbool notify=FALSE);
+  FXint getMajorTicks() const;
+
+  /// Change/return document medium ticks
+  void setMediumTicks(FXint ticks,FXbool notify=FALSE);
+  FXint getMediumTicks() const;
+
+  /// Change/return document tiny ticks
+  void setTinyTicks(FXint ticks,FXbool notify=FALSE);
+  FXint getTinyTicks() const;
+
+  /// Change/return pixel per tick spacing
+  void setPixelPerTick(FXdouble space,FXbool notify=FALSE);
+  FXdouble getPixelPerTick() const;
+
+  /// Set the text font
+  void setFont(FXFont *fnt,FXbool notify=FALSE);
+
+  /// Get the text font
+  FXFont* getFont() const;
+
+  /// Change slider value
+  void setValue(FXint value);
+
+  /// Return slider value
+  FXint getValue() const;
+
+  /// Set ruler style
+  void setRulerStyle(FXuint style);
+
+  /// Get ruler style
+  FXuint getRulerStyle() const;
+
+  /// Set ruler alignment
+  void setRulerAlignment(FXuint alignment,FXbool notify=FALSE);
+
+  /// Get ruler alignment
+  FXuint getRulerAlignment() const;
+
+  /// Get the current text color
+  FXColor getTextColor() const;
+
+  /// Set the current text color
+  void setTextColor(FXColor clr);
+
+  /// Set the status line help text for this label
+  void setHelpText(const FXString& text);
+
+  /// Get the status line help text for this label
+  const FXString& getHelpText() const;
+
+  /// Set the tool tip message for this label
+  void setTipText(const FXString& text);
+
+  /// Get the tool tip message for this label
+  const FXString& getTipText() const;
+
+  /// Destructor
+  virtual ~FXRuler();
+  };
+
+DECLARE_FXOBJECT_VIRTUALS(FXRuler)
+DECLARE_FXID_VIRTUALS(FXRuler)
+DECLARE_FXDRAWABLE_VIRTUALS(FXRuler)
+DECLARE_FXWINDOW_VIRTUALS(FXRuler)

data/swig-interfaces/FXRulerView.i

@@ -0,0 +1,233 @@
+/***********************************************************************
+ * 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".
+ ***********************************************************************/
+
+class FXRuler;
+class FXFrame;
+
+%rename("setHPixelsPerTick")	FXRulerView::setHPixelPerTick(FXdouble,FXbool);
+%rename("setVPixelsPerTick")	FXRulerView::setVPixelPerTick(FXdouble,FXbool);
+%rename("getHPixelsPerTick")	FXRulerView::getHPixelPerTick() const;
+%rename("getVPixelsPerTick")	FXRulerView::getVPixelPerTick() const;
+
+/**
+* The Ruler View provides viewing of a document with rulers.
+* It is intended to be subclassed in order to draw actual contents
+* and provide editing behavior for the document.
+* The ruler view itself simply manages the geometry of the document
+* being edited, and coordinates the movement of the ruler displays
+* as the document is being scrolled.
+*/
+class FXRulerView : public FXScrollArea {
+public:
+  long onPaint(FXObject*,FXSelector,void* PTR_EVENT);
+  long onMotion(FXObject*,FXSelector,void* PTR_EVENT);
+  long onCmdSetHelp(FXObject*,FXSelector,void*);
+  long onCmdGetHelp(FXObject*,FXSelector,void*);
+  long onCmdSetTip(FXObject*,FXSelector,void*);
+  long onCmdGetTip(FXObject*,FXSelector,void*);
+  long onQueryHelp(FXObject*,FXSelector,void*);
+  long onQueryTip(FXObject*,FXSelector,void*);
+  long onDocChanged(FXObject*,FXSelector,void*);
+public:
+  enum {
+    ID_HRULER=FXScrollArea::ID_LAST,
+    ID_VRULER,
+    ID_LAST
+    };
+public:
+
+  %extend {
+    /// Construct a rulerview window
+    FXRulerView(FXComposite* p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0){
+      return new FXRbRulerView(p,tgt,sel,opts,x,y,w,h);
+      }
+  }
+
+  /// Return a pointer to the horizontal ruler
+  FXRuler* horizontalRuler() const;
+
+  /// Return a pointer to the vertical ruler
+  FXRuler* verticalRuler() const;
+
+  /// Get document position X
+  FXint getDocumentX() const;
+
+  /// Get document position Y
+  FXint getDocumentY() const;
+
+  /// Set document width
+  void setDocumentWidth(FXint w,FXbool notify=FALSE);
+
+  /// Get document width
+  FXint getDocumentWidth() const;
+
+  /// Set document height
+  void setDocumentHeight(FXint h,FXbool notify=FALSE);
+
+  /// Get document height
+  FXint getDocumentHeight() const;
+
+  /// Set the current document color
+  void setDocumentColor(FXColor clr);
+
+  /// Get the current document color
+  FXColor getDocumentColor() const { return docColor; }
+
+  /// Change edge spacing around document
+  void setHEdgeSpacing(FXint es,FXbool notify=FALSE);
+  void setVEdgeSpacing(FXint es,FXbool notify=FALSE);
+
+  /// Return edge spacing
+  FXint getHEdgeSpacing() const;
+  FXint getVEdgeSpacing() const;
+
+  /// Change horizontal lower margin
+  void setHMarginLower(FXint marg,FXbool notify=FALSE);
+
+  /// Change horizontal upper margin
+  void setHMarginUpper(FXint marg,FXbool notify=FALSE);
+
+  /// Get horizontal lower margin
+  FXint getHMarginLower() const;
+
+  /// Get horizontal upper margin
+  FXint getHMarginUpper() const;
+
+  /// Change vertical lower margin
+  void setVMarginLower(FXint marg,FXbool notify=FALSE);
+
+  /// Change vertical upper margin
+  void setVMarginUpper(FXint marg,FXbool notify=FALSE);
+
+  /// Get vertical lower margin
+  FXint getVMarginLower() const;
+
+  /// Get vertical upper margin
+  FXint getVMarginUpper() const;
+
+  /// Set horizontal alignment; the default is RULER_ALIGN_NORMAL
+  void setHAlignment(FXuint align,FXbool notify=FALSE);
+
+  /// Return horizontal alignment
+  FXuint getHAlignment() const;
+
+  /// Set vertical alignment; the default is RULER_ALIGN_NORMAL
+  void setVAlignment(FXuint align,FXbool notify=FALSE);
+
+  /// Return vertical alignment
+  FXuint getVAlignment() const;
+
+  /// Set X arrow position, relative to document position
+  void setArrowPosX(FXint x);
+
+  /// Set X arrow position, relative to document position
+  void setArrowPosY(FXint y);
+
+  /// Get X arrow position in document
+  FXint getArrowPosX() const;
+
+  /// Get Y arrow position in document
+  FXint getArrowPosY() const;
+
+  /// Set the horizontal ruler font
+  void setHRulerFont(FXFont *fnt,FXbool notify=FALSE);
+
+  /// Get the horizontal ruler font
+  FXFont* getHRulerFont() const;
+
+  /// Set the vertical ruler font
+  void setVRulerFont(FXFont *fnt,FXbool notify=FALSE);
+
+  /// Get the vertical ruler font
+  FXFont* getVRulerFont() const;
+
+  /// Change document number placement
+  void setHNumberTicks(FXint ticks,FXbool notify=FALSE);
+  void setVNumberTicks(FXint ticks,FXbool notify=FALSE);
+
+  /// Return document number placement
+  FXint getHNumberTicks() const;
+  FXint getVNumberTicks() const;
+
+  /// Change document major ticks
+  void setHMajorTicks(FXint ticks,FXbool notify=FALSE);
+  void setVMajorTicks(FXint ticks,FXbool notify=FALSE);
+
+  /// Return document major ticks
+  FXint getHMajorTicks() const;
+  FXint getVMajorTicks() const;
+
+  /// Change document medium ticks
+  void setHMediumTicks(FXint ticks,FXbool notify=FALSE);
+  void setVMediumTicks(FXint ticks,FXbool notify=FALSE);
+
+  /// Return document medium ticks
+  FXint getHMediumTicks() const;
+  FXint getVMediumTicks() const;
+
+  /// Change document tiny ticks
+  void setHTinyTicks(FXint ticks,FXbool notify=FALSE);
+  void setVTinyTicks(FXint ticks,FXbool notify=FALSE);
+
+  /// Return document tiny ticks
+  FXint getHTinyTicks() const;
+  FXint getVTinyTicks() const;
+
+  /// Change pixel per tick spacing
+  void setHPixelPerTick(FXdouble space,FXbool notify=FALSE);
+  void setVPixelPerTick(FXdouble space,FXbool notify=FALSE);
+
+  /// Return pixel per tick spacing
+  FXdouble getHPixelPerTick() const;
+  FXdouble getVPixelPerTick() const;
+
+  /// Set ruler style
+  void setHRulerStyle(FXuint style);
+  void setVRulerStyle(FXuint style);
+
+  /// Get ruler style
+  FXuint getHRulerStyle() const;
+  FXuint getVRulerStyle() const;
+
+  /// Set the status line help text for the ruler view
+  void setHelpText(const FXString& text);
+
+  /// Get the status line help text for the ruler view
+  const FXString& getHelpText() const;
+
+  /// Set the tool tip message for the ruler view
+  void setTipText(const FXString& text);
+
+  /// Get the tool tip message for the ruler view
+  const FXString& getTipText() const;
+
+  /// Destroy
+  virtual ~FXRulerView();
+  };
+
+
+DECLARE_FXOBJECT_VIRTUALS(FXRulerView)
+DECLARE_FXID_VIRTUALS(FXRulerView)
+DECLARE_FXDRAWABLE_VIRTUALS(FXRulerView)
+DECLARE_FXWINDOW_VIRTUALS(FXRulerView)
+DECLARE_FXSCROLLAREA_VIRTUALS(FXRulerView)
+