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

FX::FXRuler Class Reference

#include <FXRuler.h>

Inheritance diagram for FX::FXRuler:
FX::FXFrame FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

Public Types

enum  {
  ID_ARROW =FXFrame::ID_LAST,
  ID_LAST
}
 
- 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
}
 

Public Member Functions

 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)
 
virtual void layout ()
 
virtual void create ()
 
virtual void detach ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
void setPosition (FXint pos, FXbool notify=FALSE)
 
FXint getPosition () const
 
void setContentSize (FXint size, FXbool notify=FALSE)
 
FXint getContentSize () const
 
FXint getDocumentLower () const
 
FXint getDocumentUpper () const
 
void setDocumentSize (FXint size, FXbool notify=FALSE)
 
FXint getDocumentSize () const
 
void setEdgeSpacing (FXint space, FXbool notify=FALSE)
 
FXint getEdgeSpacing () const
 
void setMarginLower (FXint mgn, FXbool notify=FALSE)
 
FXint getMarginLower () const
 
void setMarginUpper (FXint mgn, FXbool notify=FALSE)
 
FXint getMarginUpper () const
 
void setIndentFirst (FXint ind, FXbool notify=FALSE)
 
FXint getIndentFirst () const
 
void setIndentLower (FXint ind, FXbool notify=FALSE)
 
FXint getIndentLower () const
 
void setIndentUpper (FXint ind, FXbool notify=FALSE)
 
FXint getIndentUpper () const
 
void setNumberTicks (FXint ticks, FXbool notify=FALSE)
 
FXint getNumberTicks () const
 
void setMajorTicks (FXint ticks, FXbool notify=FALSE)
 
FXint getMajorTicks () const
 
void setMediumTicks (FXint ticks, FXbool notify=FALSE)
 
FXint getMediumTicks () const
 
void setTinyTicks (FXint ticks, FXbool notify=FALSE)
 
FXint getTinyTicks () const
 
void setPixelPerTick (FXdouble space, FXbool notify=FALSE)
 
FXdouble getPixelPerTick () const
 
void setFont (FXFont *fnt, FXbool notify=FALSE)
 
FXFontgetFont () const
 
void setValue (FXint value)
 
FXint getValue () const
 
void setRulerStyle (FXuint style)
 
FXuint getRulerStyle () const
 
void setRulerAlignment (FXuint alignment, FXbool notify=FALSE)
 
FXuint getRulerAlignment () const
 
FXColor getTextColor () const
 
void setTextColor (FXColor clr)
 
void setHelpText (const FXString &text)
 
const FXStringgetHelpText () const
 
void setTipText (const FXString &text)
 
const FXStringgetTipText () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXRuler ()
 
- Public Member Functions inherited from FX::FXFrame
 FXFrame (FXComposite *p, FXuint opts=FRAME_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)
 
void setFrameStyle (FXuint style)
 
FXuint getFrameStyle () const
 
FXint getBorderWidth () const
 
void setPadTop (FXint pt)
 
FXint getPadTop () const
 
void setPadBottom (FXint pb)
 
FXint getPadBottom () const
 
void setPadLeft (FXint pl)
 
FXint getPadLeft () const
 
void setPadRight (FXint pr)
 
FXint getPadRight () const
 
void setHiliteColor (FXColor clr)
 
FXColor getHiliteColor () const
 
void setShadowColor (FXColor clr)
 
FXColor getShadowColor () const
 
void setBorderColor (FXColor clr)
 
FXColor getBorderColor () const
 
void setBaseColor (FXColor clr)
 
FXColor getBaseColor () const
 
- 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)
 
FXWindowgetParent () const
 
FXWindowgetOwner () const
 
FXWindowgetShell () const
 
FXWindowgetRoot () const
 
FXWindowgetNext () const
 
FXWindowgetPrev () const
 
FXWindowgetFirst () const
 
FXWindowgetLast () const
 
FXWindowgetFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObjectgetTarget () 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
 
FXAccelTablegetAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXStringgetHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindowgetChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindowchildAtIndex (FXint index) const
 
FXComposeContextgetComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursorgetDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursorgetDragCursor () 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 destroy ()
 
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
 
virtual bool isComposite () 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 FXchartr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () 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 FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FX::FXWindow
static FXWindowcommonAncestor (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 widget is placed alongside a document to measure position and size of entities within the document, such as margins, paragraph indents, and tickmarks.

The ruler widget sends a SEL_CHANGED when the indentation or margins are interactively changed by the user. If the document size exceeds the available space, it is possible to scroll the document using setPosition(). When the document size is less than the available space, the alignment options can be used to center, left-adjust, or right-adjust the document. Finally, a special option exists to stretch the document to the available space, that is to say, the document will always be fitten with given left and right edges substracted from the available space.

See also:

Member Enumeration Documentation

anonymous enum
Enumerator
ID_ARROW 
ID_LAST 

Constructor & Destructor Documentation

FX::FXRuler::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 
)

Construct label with given text and icon.

virtual FX::FXRuler::~FXRuler ( )
virtual

Destructor.

Member Function Documentation

virtual void FX::FXRuler::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXWindow.

virtual void FX::FXRuler::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXWindow.

virtual void FX::FXRuler::detach ( )
virtual

Detach server-side resources.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXRuler::getDefaultWidth ( )
virtual

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXRuler::getDefaultHeight ( )
virtual

Return default height.

Reimplemented from FX::FXFrame.

void FX::FXRuler::setPosition ( FXint  pos,
FXbool  notify = FALSE 
)

Set the current position.

FXint FX::FXRuler::getPosition ( ) const
inline

Return the current position.

void FX::FXRuler::setContentSize ( FXint  size,
FXbool  notify = FALSE 
)

Change/return content size.

FXint FX::FXRuler::getContentSize ( ) const
FXint FX::FXRuler::getDocumentLower ( ) const

Get lower edge of document.

FXint FX::FXRuler::getDocumentUpper ( ) const

Get upper edge of document.

void FX::FXRuler::setDocumentSize ( FXint  size,
FXbool  notify = FALSE 
)

Change/return document size.

FXint FX::FXRuler::getDocumentSize ( ) const
inline
void FX::FXRuler::setEdgeSpacing ( FXint  space,
FXbool  notify = FALSE 
)

Change/return document edge spacing.

FXint FX::FXRuler::getEdgeSpacing ( ) const
inline
void FX::FXRuler::setMarginLower ( FXint  mgn,
FXbool  notify = FALSE 
)

Change/return lower document margin.

FXint FX::FXRuler::getMarginLower ( ) const
inline
void FX::FXRuler::setMarginUpper ( FXint  mgn,
FXbool  notify = FALSE 
)

Change/return upper document margin.

FXint FX::FXRuler::getMarginUpper ( ) const
inline
void FX::FXRuler::setIndentFirst ( FXint  ind,
FXbool  notify = FALSE 
)

Change/return first line indent.

FXint FX::FXRuler::getIndentFirst ( ) const
inline
void FX::FXRuler::setIndentLower ( FXint  ind,
FXbool  notify = FALSE 
)

Change/return lower indent.

FXint FX::FXRuler::getIndentLower ( ) const
inline
void FX::FXRuler::setIndentUpper ( FXint  ind,
FXbool  notify = FALSE 
)

Change/return upper indent.

FXint FX::FXRuler::getIndentUpper ( ) const
inline
void FX::FXRuler::setNumberTicks ( FXint  ticks,
FXbool  notify = FALSE 
)

Change/return document number placement.

FXint FX::FXRuler::getNumberTicks ( ) const
inline
void FX::FXRuler::setMajorTicks ( FXint  ticks,
FXbool  notify = FALSE 
)

Change/return document major ticks.

FXint FX::FXRuler::getMajorTicks ( ) const
inline
void FX::FXRuler::setMediumTicks ( FXint  ticks,
FXbool  notify = FALSE 
)

Change/return document medium ticks.

FXint FX::FXRuler::getMediumTicks ( ) const
inline
void FX::FXRuler::setTinyTicks ( FXint  ticks,
FXbool  notify = FALSE 
)

Change/return document tiny ticks.

FXint FX::FXRuler::getTinyTicks ( ) const
inline
void FX::FXRuler::setPixelPerTick ( FXdouble  space,
FXbool  notify = FALSE 
)

Change/return pixel per tick spacing.

FXdouble FX::FXRuler::getPixelPerTick ( ) const
inline
void FX::FXRuler::setFont ( FXFont fnt,
FXbool  notify = FALSE 
)

Set the text font.

FXFont* FX::FXRuler::getFont ( ) const
inline

Get the text font.

void FX::FXRuler::setValue ( FXint  value)

Change arrow value, relative to document position.

FXint FX::FXRuler::getValue ( ) const
inline

Return arrow value in document.

void FX::FXRuler::setRulerStyle ( FXuint  style)

Set ruler style.

FXuint FX::FXRuler::getRulerStyle ( ) const

Get ruler style.

void FX::FXRuler::setRulerAlignment ( FXuint  alignment,
FXbool  notify = FALSE 
)

Set ruler alignment.

FXuint FX::FXRuler::getRulerAlignment ( ) const

Get ruler alignment.

FXColor FX::FXRuler::getTextColor ( ) const
inline

Get the current text color.

void FX::FXRuler::setTextColor ( FXColor  clr)

Set the current text color.

void FX::FXRuler::setHelpText ( const FXString text)
inline

Set the status line help text for the ruler.

const FXString& FX::FXRuler::getHelpText ( ) const
inline

Get the status line help text for the ruler.

void FX::FXRuler::setTipText ( const FXString text)
inline

Set the tool tip message for the ruler.

const FXString& FX::FXRuler::getTipText ( ) const
inline

Get the tool tip message for the ruler.

virtual void FX::FXRuler::save ( FXStream store) const
virtual

Save label to a stream.

Reimplemented from FX::FXFrame.

virtual void FX::FXRuler::load ( FXStream store)
virtual

Load label from a stream.

Reimplemented from FX::FXFrame.

Copyright © 1997-2005 Jeroen van der Zijp