FX::FXRulerView Class Reference

The Ruler View provides viewing of a document with rulers. More...

#include <FXRulerView.h>

Inheritance diagram for FX::FXRulerView:

List of all members.

Public Types
enum	{ ID_HRULER = FXScrollArea::ID_LAST, ID_VRULER, ID_LAST }
Public Member Functions
long	onPaint (FXObject *, FXSelector, void *)
long	onMotion (FXObject *, FXSelector, void *)
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 *)
	FXRulerView (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
	Construct a rulerview window.
virtual FXint	getDefaultWidth ()
	Return default width.
virtual FXint	getDefaultHeight ()
	Return default height.
virtual FXint	getVisibleX () const
	Return visible area x position.
virtual FXint	getVisibleY () const
	Return visible area y position.
virtual FXint	getVisibleWidth () const
	Return visible area width.
virtual FXint	getVisibleHeight () const
	Return visible area height.
virtual FXint	getContentWidth ()
	Return content width.
virtual FXint	getContentHeight ()
	Return content height.
virtual void	layout ()
	Perform layout.
FXRuler *	horizontalRuler () const
	Return a pointer to the horizontal ruler.
FXRuler *	verticalRuler () const
	Return a pointer to the vertical ruler.
FXint	getDocumentX () const
	Get document position X.
FXint	getDocumentY () const
	Get document position Y.
void	setDocumentWidth (FXint w, FXbool notify=false)
	Set document width.
FXint	getDocumentWidth () const
	Get document width.
void	setDocumentHeight (FXint h, FXbool notify=false)
	Set document height.
FXint	getDocumentHeight () const
	Get document height.
void	setDocumentColor (FXColor clr)
	Set the current document color.
FXColor	getDocumentColor () const
	Get the current document color.
void	setHEdgeSpacing (FXint es, FXbool notify=false)
	Change edge spacing around document.
void	setVEdgeSpacing (FXint es, FXbool notify=false)
FXint	getHEdgeSpacing () const
	Return edge spacing.
FXint	getVEdgeSpacing () const
void	setHMarginLower (FXint marg, FXbool notify=false)
	Change horizontal lower margin.
void	setHMarginUpper (FXint marg, FXbool notify=false)
	Change horizontal upper margin.
FXint	getHMarginLower () const
	Get horizontal lower margin.
FXint	getHMarginUpper () const
	Get horizontal upper margin.
void	setVMarginLower (FXint marg, FXbool notify=false)
	Change vertical lower margin.
void	setVMarginUpper (FXint marg, FXbool notify=false)
	Change vertical upper margin.
FXint	getVMarginLower () const
	Get vertical lower margin.
FXint	getVMarginUpper () const
	Get vertical upper margin.
void	setHAlignment (FXuint align, FXbool notify=false)
	Set horizontal alignment; the default is RULER_ALIGN_NORMAL.
FXuint	getHAlignment () const
	Return horizontal alignment.
void	setVAlignment (FXuint align, FXbool notify=false)
	Set vertical alignment; the default is RULER_ALIGN_NORMAL.
FXuint	getVAlignment () const
	Return vertical alignment.
void	setArrowPosX (FXint x)
	Set X arrow position, relative to document position.
void	setArrowPosY (FXint y)
	Set X arrow position, relative to document position.
FXint	getArrowPosX () const
	Get X arrow position in document.
FXint	getArrowPosY () const
	Get Y arrow position in document.
void	setHRulerFont (FXFont *fnt, FXbool notify=false)
	Set the horizontal ruler font.
FXFont *	getHRulerFont () const
	Get the horizontal ruler font.
void	setVRulerFont (FXFont *fnt, FXbool notify=false)
	Set the vertical ruler font.
FXFont *	getVRulerFont () const
	Get the vertical ruler font.
void	setHNumberTicks (FXint ticks, FXbool notify=false)
	Change document number placement.
void	setVNumberTicks (FXint ticks, FXbool notify=false)
FXint	getHNumberTicks () const
	Return document number placement.
FXint	getVNumberTicks () const
void	setHMajorTicks (FXint ticks, FXbool notify=false)
	Change document major ticks.
void	setVMajorTicks (FXint ticks, FXbool notify=false)
FXint	getHMajorTicks () const
	Return document major ticks.
FXint	getVMajorTicks () const
void	setHMediumTicks (FXint ticks, FXbool notify=false)
	Change document medium ticks.
void	setVMediumTicks (FXint ticks, FXbool notify=false)
FXint	getHMediumTicks () const
	Return document medium ticks.
FXint	getVMediumTicks () const
void	setHTinyTicks (FXint ticks, FXbool notify=false)
	Change document tiny ticks.
void	setVTinyTicks (FXint ticks, FXbool notify=false)
FXint	getHTinyTicks () const
	Return document tiny ticks.
FXint	getVTinyTicks () const
void	setHPixelPerTick (FXdouble space, FXbool notify=false)
	Change pixel per tick spacing.
void	setVPixelPerTick (FXdouble space, FXbool notify=false)
FXdouble	getHPixelPerTick () const
	Return pixel per tick spacing.
FXdouble	getVPixelPerTick () const
void	setHRulerStyle (FXuint style)
	Set ruler style.
void	setVRulerStyle (FXuint style)
FXuint	getHRulerStyle () const
	Get ruler style.
FXuint	getVRulerStyle () const
void	setHelpText (const FXString &text)
	Set the status line help text for the ruler view.
const FXString &	getHelpText () const
	Get the status line help text for the ruler view.
void	setTipText (const FXString &text)
	Set the tool tip message for the ruler view.
const FXString &	getTipText () const
	Get the tool tip message for the ruler view.
virtual void	save (FXStream &store) const
	Save list to a stream.
virtual void	load (FXStream &store)
	Load list from a stream.
virtual	~FXRulerView ()
	Destroy.
Protected Member Functions
virtual void	moveContents (FXint x, FXint y)
virtual void	drawBackground (FXDCWindow &dc)
virtual void	drawContents (FXDCWindow &dc)
Protected Attributes
FXRuler *	hruler
FXRuler *	vruler
FXFrame *	filler
FXColor	docColor
FXString	tip
FXString	help

---

Detailed Description

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.

---

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

• /home/jeroen/FOX/fox/fox-1.7.33/include/FXRulerView.h