Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXRulerView

FX::FXRulerView Class Reference

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

#include <FXRulerView.h>

Inheritance diagram for FX::FXRulerView:

FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject List of all members.

Public Member Functions

 FXRulerView (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
virtual FXint getViewportHeight ()
virtual FXint getViewportWidth ()
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
virtual void layout ()
FXRuler * horizontalRuler () const
FXRuler * verticalRuler () const
FXint getDocumentX () const
FXint getDocumentY () const
void setDocumentWidth (FXint w, FXbool notify=FALSE)
FXint getDocumentWidth () const
void setDocumentHeight (FXint h, FXbool notify=FALSE)
FXint getDocumentHeight () const
void setDocumentColor (FXColor clr)
FXColor getDocumentColor () const
void setHEdgeSpacing (FXint es, FXbool notify=FALSE)
void setVEdgeSpacing (FXint es, FXbool notify=FALSE)
FXint getHEdgeSpacing () const
FXint getVEdgeSpacing () const
void setHMarginLower (FXint marg, FXbool notify=FALSE)
void setHMarginUpper (FXint marg, FXbool notify=FALSE)
FXint getHMarginLower () const
FXint getHMarginUpper () const
void setVMarginLower (FXint marg, FXbool notify=FALSE)
void setVMarginUpper (FXint marg, FXbool notify=FALSE)
FXint getVMarginLower () const
FXint getVMarginUpper () const
void setHAlignment (FXuint align, FXbool notify=FALSE)
FXuint getHAlignment () const
void setVAlignment (FXuint align, FXbool notify=FALSE)
FXuint getVAlignment () const
void setArrowPosX (FXint x)
void setArrowPosY (FXint y)
FXint getArrowPosX () const
FXint getArrowPosY () const
void setHRulerFont (FXFont *fnt, FXbool notify=FALSE)
FXFont * getHRulerFont () const
void setVRulerFont (FXFont *fnt, FXbool notify=FALSE)
FXFont * getVRulerFont () const
void setHNumberTicks (FXint ticks, FXbool notify=FALSE)
void setVNumberTicks (FXint ticks, FXbool notify=FALSE)
FXint getHNumberTicks () const
FXint getVNumberTicks () const
void setHMajorTicks (FXint ticks, FXbool notify=FALSE)
void setVMajorTicks (FXint ticks, FXbool notify=FALSE)
FXint getHMajorTicks () const
FXint getVMajorTicks () const
void setHMediumTicks (FXint ticks, FXbool notify=FALSE)
void setVMediumTicks (FXint ticks, FXbool notify=FALSE)
FXint getHMediumTicks () const
FXint getVMediumTicks () const
void setHTinyTicks (FXint ticks, FXbool notify=FALSE)
void setVTinyTicks (FXint ticks, FXbool notify=FALSE)
FXint getHTinyTicks () const
FXint getVTinyTicks () const
void setHPixelPerTick (FXdouble space, FXbool notify=FALSE)
void setVPixelPerTick (FXdouble space, FXbool notify=FALSE)
FXdouble getHPixelPerTick () const
FXdouble getVPixelPerTick () const
void setHRulerStyle (FXuint style)
void setVRulerStyle (FXuint style)
FXuint getHRulerStyle () const
FXuint getVRulerStyle () const
void setHelpText (const FXString &text)
const FXString & getHelpText () const
void setTipText (const FXString &text)
const FXString & getTipText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXRulerView ()

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.

Constructor & Destructor Documentation

FX::FXRulerView::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 FX::FXRulerView::~FXRulerView (   )  [virtual]
 

Destroy.

Member Function Documentation

virtual FXint FX::FXRulerView::getViewportHeight (   )  [virtual]
 

Return viewport height.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXRulerView::getViewportWidth (   )  [virtual]
 

Return viewport width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXRulerView::getContentWidth (   )  [virtual]
 

Return content width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXRulerView::getContentHeight (   )  [virtual]
 

Return content height.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXRulerView::layout (   )  [virtual]
 

Perform layout.

Reimplemented from FX::FXScrollArea.

FXRuler* FX::FXRulerView::horizontalRuler (   )  const [inline]
 

Return a pointer to the horizontal ruler.

FXRuler* FX::FXRulerView::verticalRuler (   )  const [inline]
 

Return a pointer to the vertical ruler.

FXint FX::FXRulerView::getDocumentX (   )  const
 

Get document position X.

FXint FX::FXRulerView::getDocumentY (   )  const
 

Get document position Y.

void FX::FXRulerView::setDocumentWidth (  FXint  w,
FXbool  notify = FALSE
) 
 

Set document width.

FXint FX::FXRulerView::getDocumentWidth (   )  const
 

Get document width.

void FX::FXRulerView::setDocumentHeight (  FXint  h,
FXbool  notify = FALSE
) 
 

Set document height.

FXint FX::FXRulerView::getDocumentHeight (   )  const
 

Get document height.

void FX::FXRulerView::setDocumentColor (  FXColor  clr  ) 
 

Set the current document color.

FXColor FX::FXRulerView::getDocumentColor (   )  const [inline]
 

Get the current document color.

void FX::FXRulerView::setHEdgeSpacing (  FXint  es,
FXbool  notify = FALSE
) 
 

Change edge spacing around document.

void FX::FXRulerView::setVEdgeSpacing (  FXint  es,
FXbool  notify = FALSE
) 
 

FXint FX::FXRulerView::getHEdgeSpacing (   )  const
 

Return edge spacing.

FXint FX::FXRulerView::getVEdgeSpacing (   )  const
 

void FX::FXRulerView::setHMarginLower (  FXint  marg,
FXbool  notify = FALSE
) 
 

Change horizontal lower margin.

void FX::FXRulerView::setHMarginUpper (  FXint  marg,
FXbool  notify = FALSE
) 
 

Change horizontal upper margin.

FXint FX::FXRulerView::getHMarginLower (   )  const
 

Get horizontal lower margin.

FXint FX::FXRulerView::getHMarginUpper (   )  const
 

Get horizontal upper margin.

void FX::FXRulerView::setVMarginLower (  FXint  marg,
FXbool  notify = FALSE
) 
 

Change vertical lower margin.

void FX::FXRulerView::setVMarginUpper (  FXint  marg,
FXbool  notify = FALSE
) 
 

Change vertical upper margin.

FXint FX::FXRulerView::getVMarginLower (   )  const
 

Get vertical lower margin.

FXint FX::FXRulerView::getVMarginUpper (   )  const
 

Get vertical upper margin.

void FX::FXRulerView::setHAlignment (  FXuint  align,
FXbool  notify = FALSE
) 
 

Set horizontal alignment; the default is RULER_ALIGN_NORMAL.

FXuint FX::FXRulerView::getHAlignment (   )  const
 

Return horizontal alignment.

void FX::FXRulerView::setVAlignment (  FXuint  align,
FXbool  notify = FALSE
) 
 

Set vertical alignment; the default is RULER_ALIGN_NORMAL.

FXuint FX::FXRulerView::getVAlignment (   )  const
 

Return vertical alignment.

void FX::FXRulerView::setArrowPosX (  FXint  x  ) 
 

Set X arrow position, relative to document position.

void FX::FXRulerView::setArrowPosY (  FXint  y  ) 
 

Set X arrow position, relative to document position.

FXint FX::FXRulerView::getArrowPosX (   )  const
 

Get X arrow position in document.

FXint FX::FXRulerView::getArrowPosY (   )  const
 

Get Y arrow position in document.

void FX::FXRulerView::setHRulerFont (  FXFont *  fnt,
FXbool  notify = FALSE
) 
 

Set the horizontal ruler font.

FXFont* FX::FXRulerView::getHRulerFont (   )  const
 

Get the horizontal ruler font.

void FX::FXRulerView::setVRulerFont (  FXFont *  fnt,
FXbool  notify = FALSE
) 
 

Set the vertical ruler font.

FXFont* FX::FXRulerView::getVRulerFont (   )  const
 

Get the vertical ruler font.

void FX::FXRulerView::setHNumberTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

Change document number placement.

void FX::FXRulerView::setVNumberTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

FXint FX::FXRulerView::getHNumberTicks (   )  const
 

Return document number placement.

FXint FX::FXRulerView::getVNumberTicks (   )  const
 

void FX::FXRulerView::setHMajorTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

Change document major ticks.

void FX::FXRulerView::setVMajorTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

FXint FX::FXRulerView::getHMajorTicks (   )  const
 

Return document major ticks.

FXint FX::FXRulerView::getVMajorTicks (   )  const
 

void FX::FXRulerView::setHMediumTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

Change document medium ticks.

void FX::FXRulerView::setVMediumTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

FXint FX::FXRulerView::getHMediumTicks (   )  const
 

Return document medium ticks.

FXint FX::FXRulerView::getVMediumTicks (   )  const
 

void FX::FXRulerView::setHTinyTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

Change document tiny ticks.

void FX::FXRulerView::setVTinyTicks (  FXint  ticks,
FXbool  notify = FALSE
) 
 

FXint FX::FXRulerView::getHTinyTicks (   )  const
 

Return document tiny ticks.

FXint FX::FXRulerView::getVTinyTicks (   )  const
 

void FX::FXRulerView::setHPixelPerTick (  FXdouble  space,
FXbool  notify = FALSE
) 
 

Change pixel per tick spacing.

void FX::FXRulerView::setVPixelPerTick (  FXdouble  space,
FXbool  notify = FALSE
) 
 

FXdouble FX::FXRulerView::getHPixelPerTick (   )  const
 

Return pixel per tick spacing.

FXdouble FX::FXRulerView::getVPixelPerTick (   )  const
 

void FX::FXRulerView::setHRulerStyle (  FXuint  style  ) 
 

Set ruler style.

void FX::FXRulerView::setVRulerStyle (  FXuint  style  ) 
 

FXuint FX::FXRulerView::getHRulerStyle (   )  const
 

Get ruler style.

FXuint FX::FXRulerView::getVRulerStyle (   )  const
 

void FX::FXRulerView::setHelpText (  const FXString &  text  )  [inline]
 

Set the status line help text for the ruler view.

const FXString& FX::FXRulerView::getHelpText (   )  const [inline]
 

Get the status line help text for the ruler view.

void FX::FXRulerView::setTipText (  const FXString &  text  )  [inline]
 

Set the tool tip message for the ruler view.

const FXString& FX::FXRulerView::getTipText (   )  const [inline]
 

Get the tool tip message for the ruler view.

virtual void FX::FXRulerView::save (  FXStream &  store  )  const [virtual]
 

Save list to a stream.

Reimplemented from FX::FXWindow.

virtual void FX::FXRulerView::load (  FXStream &  store  )  [virtual]
 

Load list from a stream.

Reimplemented from FX::FXWindow.

Copyright © 1997-2005 Jeroen van der Zijp