/***********************************************************************
* 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 "[email protected]".
***********************************************************************/
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)