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

Public Member Functions | List of all members
FX::FXRulerView Class Reference

#include <FXRulerView.h>

Inheritance diagram for FX::FXRulerView:
FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

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 ()
 
- Public Member Functions inherited from FX::FXScrollArea
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
void setScrollStyle (FXuint style)
 
FXuint getScrollStyle () const
 
FXbool isHorizontalScrollable () const
 
FXbool isVerticalScrollable () const
 
FXScrollBar * horizontalScrollBar () const
 
FXScrollBar * verticalScrollBar () const
 
FXint getXPosition () const
 
FXint getYPosition () const
 
void setPosition (FXint x, FXint y)
 
void getPosition (FXint &x, FXint &y) const
 
virtual ~FXScrollArea ()
 
- Public Member Functions inherited from FX::FXComposite
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void create ()
 
virtual void detach ()
 
virtual void destroy ()
 
FXint maxChildWidth () const
 
FXint maxChildHeight () const
 
virtual bool isComposite () const
 
virtual ~FXComposite ()
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindow * getParent () const
 
FXWindow * getOwner () const
 
FXWindow * getShell () const
 
FXWindow * getRoot () const
 
FXWindow * getNext () const
 
FXWindow * getPrev () const
 
FXWindow * getFirst () const
 
FXWindow * getLast () const
 
FXWindow * getFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObject * getTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTable * getAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXString & getHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindow * getChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindow * childAtIndex (FXint index) const
 
FXComposeContext * getComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursor * getDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursor * getDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
virtual bool canFocus () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void enable ()
 
virtual void disable ()
 
virtual void attach (FXID w)
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
virtual void recalc ()
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
virtual void setBackColor (FXColor clr)
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchar * tr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisual * getVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXApp * getApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchar * getClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindow * commonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

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