FX::FXRuler Class Reference

#include <FXRuler.h>

Inheritance diagram for FX::FXRuler:

Inheritance graph
[legend]

List of all members.


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.

Public Types

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

long onPaint (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onCmdSetValue (FXObject *, FXSelector, void *)
long onCmdSetIntValue (FXObject *, FXSelector, void *)
long onCmdGetIntValue (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 *)
 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 ()
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
long onMap (FXObject *, FXSelector, void *)
long onUnmap (FXObject *, FXSelector, void *)
long onConfigure (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onEnter (FXObject *, FXSelector, void *)
long onLeave (FXObject *, FXSelector, void *)
long onMiddleBtnPress (FXObject *, FXSelector, void *)
long onMiddleBtnRelease (FXObject *, FXSelector, void *)
long onRightBtnPress (FXObject *, FXSelector, void *)
long onRightBtnRelease (FXObject *, FXSelector, void *)
long onBeginDrag (FXObject *, FXSelector, void *)
long onEndDrag (FXObject *, FXSelector, void *)
long onDragged (FXObject *, FXSelector, void *)
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onDestroy (FXObject *, FXSelector, void *)
long onFocusSelf (FXObject *, FXSelector, void *)
long onFocusIn (FXObject *, FXSelector, void *)
long onFocusOut (FXObject *, FXSelector, void *)
long onSelectionLost (FXObject *, FXSelector, void *)
long onSelectionGained (FXObject *, FXSelector, void *)
long onSelectionRequest (FXObject *, FXSelector, void *)
long onClipboardLost (FXObject *, FXSelector, void *)
long onClipboardGained (FXObject *, FXSelector, void *)
long onClipboardRequest (FXObject *, FXSelector, void *)
long onDNDEnter (FXObject *, FXSelector, void *)
long onDNDLeave (FXObject *, FXSelector, void *)
long onDNDMotion (FXObject *, FXSelector, void *)
long onDNDDrop (FXObject *, FXSelector, void *)
long onDNDRequest (FXObject *, FXSelector, void *)
long onCmdShow (FXObject *, FXSelector, void *)
long onCmdHide (FXObject *, FXSelector, void *)
long onUpdToggleShown (FXObject *, FXSelector, void *)
long onCmdToggleShown (FXObject *, FXSelector, void *)
long onCmdRaise (FXObject *, FXSelector, void *)
long onCmdLower (FXObject *, FXSelector, void *)
long onCmdEnable (FXObject *, FXSelector, void *)
long onCmdDisable (FXObject *, FXSelector, void *)
long onUpdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdUpdate (FXObject *, FXSelector, void *)
long onUpdYes (FXObject *, FXSelector, void *)
long onCmdDelete (FXObject *, FXSelector, void *)
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 isPopup () 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 setSavedCursor (FXCursor *cur)
FXCursorgetSavedCursor () 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
FXint getWidth () const
FXint getHeight () const
FXVisualgetVisual () const
void setVisual (FXVisual *vis)
FXAppgetApp () const
FXEventLoopgetEventLoop () const
FXID id () const
void setUserData (void *ptr)
void * getUserData () const
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)
QTransString tr (const char *text, const char *hint=0)
virtual void * getPythonObject () const
virtual void decouplePythonObject () const

Static Public Member Functions

static FXuint userHandednessLayout ()
static FXuint defaultPadding ()
static FXuint defaultSpacing ()
static FXuint scaleLayoutValue (FXuint value)
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

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

Protected Types

enum  {
  MOUSE_NONE, MOUSE_MARG_LOWER, MOUSE_MARG_UPPER, MOUSE_PARA_FIRST,
  MOUSE_PARA_LOWER, MOUSE_PARA_UPPER
}
enum  {
  FLAG_SHOWN, FLAG_ENABLED, FLAG_UPDATE, FLAG_DROPTARGET,
  FLAG_FOCUSED, FLAG_DIRTY, FLAG_RECALC, FLAG_TIP,
  FLAG_HELP, FLAG_DEFAULT, FLAG_INITIAL, FLAG_SHELL,
  FLAG_ACTIVE, FLAG_PRESSED, FLAG_KEY, FLAG_CARET,
  FLAG_CHANGED, FLAG_LASSO, FLAG_TRYDRAG, FLAG_DODRAG,
  FLAG_SCROLLINSIDE, FLAG_SCROLLING, FLAG_OWNED, FLAG_POPUP
}

Protected Member Functions

FXint picked (FXint x, FXint y)
void drawLeftArrow (FXDCWindow &dc, FXint x, FXint y)
void drawRightArrow (FXDCWindow &dc, FXint x, FXint y)
void drawUpArrow (FXDCWindow &dc, FXint x, FXint y)
void drawDownArrow (FXDCWindow &dc, FXint x, FXint y)
void drawLeftMarker (FXDCWindow &dc, FXint x, FXint y)
void drawRightMarker (FXDCWindow &dc, FXint x, FXint y)
void drawUpMarker (FXDCWindow &dc, FXint x, FXint y)
void drawDownMarker (FXDCWindow &dc, FXint x, FXint y)
void drawBorderRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRidgeRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawGrooveRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawFrame (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
virtual bool doesOverrideRedirect () const
void addColormapWindows ()
void remColormapWindows ()

Static Protected Member Functions

static FXWindowfindDefault (FXWindow *window)
static FXWindowfindInitial (FXWindow *window)

Protected Attributes

FXFontfont
FXint documentSize
FXint edgeSpacing
FXint marginLower
FXint marginUpper
FXint indentFirst
FXint indentLower
FXint indentUpper
FXdouble pixelPerTick
FXint numberTicks
FXint majorTicks
FXint mediumTicks
FXint tinyTicks
FXint arrowPos
FXColor textColor
FXint shift
FXint pos
FXint off
FXString tip
FXString help
FXuchar mode
FXColor baseColor
FXColor hiliteColor
FXColor shadowColor
FXColor borderColor
FXint padtop
FXint padbottom
FXint padleft
FXint padright
FXint border
FXComposeContextcomposeContext
FXCursordefaultCursor
FXCursorsavedCursor
FXCursordragCursor
FXAccelTableaccelTable
FXObjecttarget
FXSelector message
FXint xpos
FXint ypos
FXColor backColor
FXString tag
FXuint flags
FXuint options
FXVisualvisual
FXint width
FXint height
FXID xid

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::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.

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

Change/return document edge spacing.

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

Change/return lower document margin.

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

Change/return upper document margin.

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

Change/return first line indent.

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

Change/return lower indent.

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

Change/return upper indent.

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

Change/return document number placement.

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

Change/return document major ticks.

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

Change/return document medium ticks.

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

Change/return document tiny ticks.

void FX::FXRuler::setPixelPerTick ( FXdouble  space,
FXbool  notify = FALSE 
)

Change/return pixel per tick spacing.

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.

void FX::FXFrame::setFrameStyle ( FXuint  style  )  [inherited]

Change frame style.

FXuint FX::FXFrame::getFrameStyle (  )  const [inherited]

Get current frame style.

FXint FX::FXFrame::getBorderWidth (  )  const [inline, inherited]

Get border width.

void FX::FXFrame::setPadTop ( FXint  pt  )  [inherited]

Change top padding.

FXint FX::FXFrame::getPadTop (  )  const [inline, inherited]

Get top interior padding.

void FX::FXFrame::setPadBottom ( FXint  pb  )  [inherited]

Change bottom padding.

FXint FX::FXFrame::getPadBottom (  )  const [inline, inherited]

Get bottom interior padding.

void FX::FXFrame::setPadLeft ( FXint  pl  )  [inherited]

Change left padding.

FXint FX::FXFrame::getPadLeft (  )  const [inline, inherited]

Get left interior padding.

void FX::FXFrame::setPadRight ( FXint  pr  )  [inherited]

Change right padding.

FXint FX::FXFrame::getPadRight (  )  const [inline, inherited]

Get right interior padding.

void FX::FXFrame::setHiliteColor ( FXColor  clr  )  [inherited]

Change highlight color.

FXColor FX::FXFrame::getHiliteColor (  )  const [inline, inherited]

Get highlight color.

void FX::FXFrame::setShadowColor ( FXColor  clr  )  [inherited]

Change shadow color.

FXColor FX::FXFrame::getShadowColor (  )  const [inline, inherited]

Get shadow color.

void FX::FXFrame::setBorderColor ( FXColor  clr  )  [inherited]

Change border color.

FXColor FX::FXFrame::getBorderColor (  )  const [inline, inherited]

Get border color.

void FX::FXFrame::setBaseColor ( FXColor  clr  )  [inherited]

Change base gui color.

FXColor FX::FXFrame::getBaseColor (  )  const [inline, inherited]

Get base gui color.

static FXuint FX::FXWindow::userHandednessLayout (  )  [inline, static, inherited]

Returns LAYOUT_RIGHT or LAYOUT_LEFT suitable for the current user's handedness.

References FX::FXProcess::userHandedness().

static FXuint FX::FXWindow::defaultPadding (  )  [inline, static, inherited]

Returns the default padding quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::defaultSpacing (  )  [inline, static, inherited]

Returns the default child spacing quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::scaleLayoutValue ( FXuint  value  )  [inline, static, inherited]

Scales a layout value by a factor.

References FX::FXProcess::screenScale().

FXWindow* FX::FXWindow::getParent (  )  const [inline, inherited]

Return a pointer to the parent window.

FXWindow* FX::FXWindow::getOwner (  )  const [inline, inherited]

Return a pointer to the owner window.

FXWindow* FX::FXWindow::getShell (  )  const [inherited]

Return a pointer to the shell window.

FXWindow* FX::FXWindow::getRoot (  )  const [inherited]

Return a pointer to the root window.

FXWindow* FX::FXWindow::getNext (  )  const [inline, inherited]

Return a pointer to the next (sibling) window, if any.

FXWindow* FX::FXWindow::getPrev (  )  const [inline, inherited]

Return a pointer to the previous (sibling) window , if any.

FXWindow* FX::FXWindow::getFirst (  )  const [inline, inherited]

Return a pointer to this window's first child window , if any.

FXWindow* FX::FXWindow::getLast (  )  const [inline, inherited]

Return a pointer to this window's last child window, if any.

FXWindow* FX::FXWindow::getFocus (  )  const [inline, inherited]

Return a pointer to the currently focused child window.

void FX::FXWindow::setKey ( FXuint  k  )  [inline, inherited]

Change window key.

FXuint FX::FXWindow::getKey (  )  const [inline, inherited]

Return window key.

void FX::FXWindow::setTarget ( FXObject t  )  [inline, inherited]

Set the message target object for this window.

FXObject* FX::FXWindow::getTarget (  )  const [inline, inherited]

Get the message target object for this window, if any.

void FX::FXWindow::setSelector ( FXSelector  sel  )  [inline, inherited]

Set the message identifier for this window.

FXSelector FX::FXWindow::getSelector (  )  const [inline, inherited]

Get the message identifier for this window.

FXint FX::FXWindow::getX (  )  const [inline, inherited]

Get this window's x-coordinate, in the parent's coordinate system.

FXint FX::FXWindow::getY (  )  const [inline, inherited]

Get this window's y-coordinate, in the parent's coordinate system.

virtual FXint FX::FXWindow::getWidthForHeight ( FXint  givenheight  )  [virtual, inherited]

Return width for given height.

Reimplemented in FX::FXDockSite.

virtual FXint FX::FXWindow::getHeightForWidth ( FXint  givenwidth  )  [virtual, inherited]

Return height for given width.

Reimplemented in FX::FXDockSite.

void FX::FXWindow::setX ( FXint  x  )  [inherited]

Set this window's x-coordinate, in the parent's coordinate system.

void FX::FXWindow::setY ( FXint  y  )  [inherited]

Set this window's y-coordinate, in the parent's coordinate system.

void FX::FXWindow::setWidth ( FXint  w  )  [inherited]

Set the window width; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setHeight ( FXint  h  )  [inherited]

Set the window height; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setLayoutHints ( FXuint  lout  )  [inherited]

Set layout hints for this window.

FXuint FX::FXWindow::getLayoutHints (  )  const [inherited]

Get layout hints for this window.

FXAccelTable* FX::FXWindow::getAccelTable (  )  const [inline, inherited]

Return a pointer to the accelerator table.

void FX::FXWindow::setAccelTable ( FXAccelTable acceltable  )  [inline, inherited]

Set the accelerator table.

void FX::FXWindow::addHotKey ( FXHotKey  code  )  [inherited]

Add a hot key.

void FX::FXWindow::remHotKey ( FXHotKey  code  )  [inherited]

Remove a hot key.

void FX::FXWindow::setHelpTag ( const FXString text  )  [inline, inherited]

Change help tag for this widget.

const FXString& FX::FXWindow::getHelpTag (  )  const [inline, inherited]

Get the help tag for this widget.

bool FX::FXWindow::isShell (  )  const [inherited]

Return true if window is a shell window.

bool FX::FXWindow::isPopup (  )  const [inherited]

Return true if window is a popup window.

bool FX::FXWindow::isOwnerOf ( const FXWindow window  )  const [inherited]

Return true if specified window is owned by this window.

bool FX::FXWindow::isChildOf ( const FXWindow window  )  const [inherited]

Return true if specified window is ancestor of this window.

bool FX::FXWindow::containsChild ( const FXWindow child  )  const [inherited]

Return true if this window contains child in its subtree.

FXWindow* FX::FXWindow::getChildAt ( FXint  x,
FXint  y 
) const [inherited]

Return the child window at specified coordinates.

FXint FX::FXWindow::numChildren (  )  const [inherited]

Return the number of child windows for this window.

FXint FX::FXWindow::indexOfChild ( const FXWindow window  )  const [inherited]

Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL

FXWindow* FX::FXWindow::childAtIndex ( FXint  index  )  const [inherited]

Return the child window at specified index, or NULL if the index is negative or out of range

static FXWindow* FX::FXWindow::commonAncestor ( FXWindow a,
FXWindow b 
) [static, inherited]

Return the common ancestor of window a and window b.

static bool FX::FXWindow::before ( const FXWindow a,
const FXWindow b 
) [static, inherited]

Return TRUE if sibling a <= sibling b in list.

static bool FX::FXWindow::after ( const FXWindow a,
const FXWindow b 
) [static, inherited]

Return TRUE if sibling a >= sibling b in list.

FXComposeContext* FX::FXWindow::getComposeContext (  )  const [inline, inherited]

Return compose context.

void FX::FXWindow::createComposeContext (  )  [inherited]

Create compose context.

void FX::FXWindow::destroyComposeContext (  )  [inherited]

Destroy compose context.

void FX::FXWindow::setDefaultCursor ( FXCursor cur  )  [inherited]

Set the default cursor for this window.

FXCursor* FX::FXWindow::getDefaultCursor (  )  const [inline, inherited]

Return the default cursor for this window.

void FX::FXWindow::setSavedCursor ( FXCursor cur  )  [inline, inherited]

Set the saved cursor for this window.

FXCursor* FX::FXWindow::getSavedCursor (  )  const [inline, inherited]

Return the saved cursor for this window.

void FX::FXWindow::setDragCursor ( FXCursor cur  )  [inherited]

Set the drag cursor for this window.

FXCursor* FX::FXWindow::getDragCursor (  )  const [inline, inherited]

Return the drag cursor for this window.

FXint FX::FXWindow::getCursorPosition ( FXint &  x,
FXint &  y,
FXuint &  buttons 
) const [inherited]

Return the cursor position and mouse button-state.

FXint FX::FXWindow::setCursorPosition ( FXint  x,
FXint  y 
) [inherited]

Warp the cursor to the new position.

bool FX::FXWindow::isEnabled (  )  const [inherited]

Return true if this window is able to receive mouse and keyboard events.

bool FX::FXWindow::isActive (  )  const [inherited]

Return true if the window is active.

virtual bool FX::FXWindow::canFocus (  )  const [virtual, inherited]

bool FX::FXWindow::hasFocus (  )  const [inherited]

Return true if this window has the focus.

bool FX::FXWindow::inFocusChain (  )  const [inherited]

Return true if this window is in focus chain.

virtual void FX::FXWindow::setFocus (  )  [virtual, inherited]

virtual void FX::FXWindow::killFocus (  )  [virtual, inherited]

virtual void FX::FXWindow::changeFocus ( FXWindow child  )  [virtual, inherited]

Notification that focus moved to new child.

Reimplemented in FX::FXTable.

virtual void FX::FXWindow::setDefault ( FXbool  enable = TRUE  )  [virtual, inherited]

This changes the default window which responds to the Return key in a dialog. If enable is TRUE, this window becomes the default window; when enable is FALSE, this window will be no longer the default window. Finally, when enable is MAYBE, the default window will revert to the initial default window.

Reimplemented in FX::FXButton.

bool FX::FXWindow::isDefault (  )  const [inherited]

Return true if this is the default window.

void FX::FXWindow::setInitial ( bool  enable = true  )  [inherited]

Make this window the initial default window.

bool FX::FXWindow::isInitial (  )  const [inherited]

Return true if this is the initial default window.

virtual void FX::FXWindow::enable (  )  [virtual, inherited]

virtual void FX::FXWindow::disable (  )  [virtual, inherited]

virtual void FX::FXWindow::attach ( FXID  w  )  [virtual, inherited]

Attach foreign window handle to this window.

virtual void FX::FXWindow::destroy (  )  [virtual, inherited]

virtual void FX::FXWindow::setShape ( const FXRegion region  )  [virtual, inherited]

Set window shape by means of region.

virtual void FX::FXWindow::setShape ( FXBitmap bitmap  )  [virtual, inherited]

Set window shape by means of bitmap.

virtual void FX::FXWindow::setShape ( FXIcon icon  )  [virtual, inherited]

Set window shape by means of icon.

virtual void FX::FXWindow::clearShape (  )  [virtual, inherited]

Clear window shape.

virtual void FX::FXWindow::raise (  )  [virtual, inherited]

Raise this window to the top of the stacking order.

Reimplemented in FX::FXTopWindow.

virtual void FX::FXWindow::lower (  )  [virtual, inherited]

Lower this window to the bottom of the stacking order.

virtual void FX::FXWindow::move ( FXint  x,
FXint  y 
) [virtual, inherited]

Move the window immediately, in the parent's coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.

Reimplemented in FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::resize ( FXint  w,
FXint  h 
) [virtual, inherited]

Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized. Perform layout of the children when necessary.

Reimplemented from FX::FXDrawable.

Reimplemented in FX::FXIconList, FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::position ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) [virtual, inherited]

Move and resize the window immediately, in the parent's coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.

Reimplemented in FX::FXIconList, FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::recalc (  )  [virtual, inherited]

Mark this window's layout as dirty for later layout.

Reimplemented in FX::FXFoldingList, FX::FXIconList, FX::FXList, FX::FXRootWindow, FX::FXShell, FX::FXTable, FX::FXText, and FX::FXTreeList.

void FX::FXWindow::forceRefresh (  )  [inherited]

Generate a SEL_UPDATE message for the window and its children.

virtual void FX::FXWindow::reparent ( FXWindow father,
FXWindow other = NULL 
) [virtual, inherited]

Reparent this window under new father before other.

void FX::FXWindow::scroll ( FXint  x,
FXint  y,
FXint  w,
FXint  h,
FXint  dx,
FXint  dy 
) const [inherited]

Scroll rectangle x,y,w,h by a shift of dx,dy.

void FX::FXWindow::update ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) const [inherited]

Mark the specified rectangle to be repainted later.

void FX::FXWindow::update (  )  const [inherited]

Mark the entire window to be repainted later.

void FX::FXWindow::repaint ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) const [inherited]

Process any outstanding repaint messages immediately, for the given rectangle.

void FX::FXWindow::repaint (  )  const [inherited]

Process any outstanding repaint messages immediately.

void FX::FXWindow::grab (  )  [inherited]

Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window

void FX::FXWindow::ungrab (  )  [inherited]

Release the mouse grab.

bool FX::FXWindow::grabbed (  )  const [inherited]

Return true if the window has been grabbed.

void FX::FXWindow::grabKeyboard (  )  [inherited]

Grab keyboard device.

void FX::FXWindow::ungrabKeyboard (  )  [inherited]

Ungrab keyboard device.

bool FX::FXWindow::grabbedKeyboard (  )  const [inherited]

Return true if active grab is in effect.

virtual void FX::FXWindow::show (  )  [virtual, inherited]

Show this window.

Reimplemented in FX::FXPopup, FX::FXScrollPane, FX::FXSplashWindow, FX::FXToolTip, and FX::FXTopWindow.

virtual void FX::FXWindow::hide (  )  [virtual, inherited]

Hide this window.

Reimplemented in FX::FXDirDialog, FX::FXFileDialog, FX::FXPopup, FX::FXSplashWindow, and FX::FXTopWindow.

bool FX::FXWindow::shown (  )  const [inherited]

Return true if the window is shown.

virtual bool FX::FXWindow::isComposite (  )  const [virtual, inherited]

Return true if the window is composite.

Reimplemented in FX::FXComposite.

bool FX::FXWindow::underCursor (  )  const [inherited]

Return true if the window is under the cursor.

bool FX::FXWindow::hasSelection (  )  const [inherited]

Return true if this window owns the primary selection.

bool FX::FXWindow::acquireSelection ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Try to acquire the primary selection, given a list of drag types.

bool FX::FXWindow::releaseSelection (  )  [inherited]

Release the primary selection.

bool FX::FXWindow::hasClipboard (  )  const [inherited]

Return true if this window owns the clipboard.

bool FX::FXWindow::acquireClipboard ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Try to acquire the clipboard, given a list of drag types.

bool FX::FXWindow::releaseClipboard (  )  [inherited]

Release the clipboard.

virtual void FX::FXWindow::dropEnable (  )  [virtual, inherited]

Enable this window to receive drops.

virtual void FX::FXWindow::dropDisable (  )  [virtual, inherited]

Disable this window from receiving drops.

bool FX::FXWindow::isDropEnabled (  )  const [inherited]

Return true if this window is able to receive drops.

bool FX::FXWindow::isDragging (  )  const [inherited]

Return true if a drag operaion has been initiated from this window.

bool FX::FXWindow::beginDrag ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Initiate a drag operation with a list of previously registered drag types.

bool FX::FXWindow::handleDrag ( FXint  x,
FXint  y,
FXDragAction  action = DRAG_COPY 
) [inherited]

When dragging, inform the drop-target of the new position and the drag action

FXDragAction FX::FXWindow::endDrag ( bool  drop = true  )  [inherited]

Terminate the drag operation with or without actually dropping the data Returns the action performed by the target

bool FX::FXWindow::isDropTarget (  )  const [inherited]

Return true if this window is the target of a drop.

void FX::FXWindow::setDragRectangle ( FXint  x,
FXint  y,
FXint  w,
FXint  h,
bool  wantupdates = true 
) const [inherited]

When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle

void FX::FXWindow::clearDragRectangle (  )  const [inherited]

When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves

void FX::FXWindow::acceptDrop ( FXDragAction  action = DRAG_ACCEPT  )  const [inherited]

When being dragged over, indicate acceptance or rejection of the dragged data.

FXDragAction FX::FXWindow::didAccept (  )  const [inherited]

The target accepted our drop.

void FX::FXWindow::dropFinished ( FXDragAction  action = DRAG_REJECT  )  const [inherited]

Sent by the drop target in response to SEL_DND_DROP. The drag action should be the same as the action the drop target reported to the drag source in reponse to the SEL_DND_MOTION message. This function notifies the drag source that its part of the drop transaction is finished, and that it is free to release any resources involved in the drag operation. Calling dropFinished() is advisable in cases where the drop target needs to perform complex processing on the data received from the drag source, prior to returning from the SEL_DND_DROP message handler.

bool FX::FXWindow::inquireDNDTypes ( FXDNDOrigin  origin,
FXDragType *&  types,
FXuint &  numtypes 
) const [inherited]

When being dragged over, inquire the drag types which are being offered.

bool FX::FXWindow::offeredDNDType ( FXDNDOrigin  origin,
FXDragType  type 
) const [inherited]

When being dragged over, return true if we are offered the given drag type.

FXDragAction FX::FXWindow::inquireDNDAction (  )  const [inherited]

When being dragged over, return the drag action.

bool FX::FXWindow::setDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXuchar *  data,
FXuint  size 
) const [inherited]

Set DND data; the array must be allocated with FXMALLOC and ownership is transferred to the system

bool FX::FXWindow::setDNDData ( FXDNDOrigin  origin,
FXDragType  type,
const FXString string 
) const [inherited]

Set DND data from string value.

bool FX::FXWindow::getDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXuchar *&  data,
FXuint &  size 
) const [inherited]

Get DND data; the caller becomes the owner of the array and must free it with FXFREE

bool FX::FXWindow::getDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXString string 
) const [inherited]

Get DND data into string value.

virtual bool FX::FXWindow::contains ( FXint  parentx,
FXint  parenty 
) const [virtual, inherited]

Return true if window logically contains the given point.

Reimplemented in FX::FXMenuBar, FX::FXMenuButton, FX::FXMenuCascade, FX::FXMenuPane, FX::FXMenuTitle, and FX::FXOptionMenu.

void FX::FXWindow::translateCoordinatesFrom ( FXint &  tox,
FXint &  toy,
const FXWindow fromwindow,
FXint  fromx,
FXint  fromy 
) const [inherited]

Translate coordinates from fromwindow's coordinate space to this window's coordinate space.

void FX::FXWindow::translateCoordinatesTo ( FXint &  tox,
FXint &  toy,
const FXWindow towindow,
FXint  fromx,
FXint  fromy 
) const [inherited]

Translate coordinates from this window's coordinate space to towindow's coordinate space.

virtual void FX::FXWindow::setBackColor ( FXColor  clr  )  [virtual, inherited]

Set window background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXColor FX::FXWindow::getBackColor (  )  const [inline, inherited]

Get background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXint FX::FXDrawable::getWidth (  )  const [inline, inherited]

Width of drawable.

FXint FX::FXDrawable::getHeight (  )  const [inline, inherited]

Height of drawable.

FXVisual* FX::FXDrawable::getVisual (  )  const [inline, inherited]

Get the visual.

void FX::FXDrawable::setVisual ( FXVisual vis  )  [inherited]

Change visual.

FXApp* FX::FXId::getApp (  )  const [inline, inherited]

Get application.

FXEventLoop* FX::FXId::getEventLoop (  )  const [inline, inherited]

Get event loop which owns this.

FXID FX::FXId::id (  )  const [inline, inherited]

Get XID handle.

void FX::FXId::setUserData ( void *  ptr  )  [inline, inherited]

Set user data pointer.

void* FX::FXId::getUserData (  )  const [inline, inherited]

Get user data pointer.

virtual long FX::FXObject::onDefault ( FXObject ,
FXSelector  ,
void *   
) [virtual, inherited]

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName (  )  const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass metaclass  )  const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle ( FXObject sender,
FXSelector  sel,
void *  ptr 
) [virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr ( const char *  text,
const char *  hint = 0 
) [inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject (  )  const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject (  )  const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).


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

(C) 2002-2008 Niall Douglas. Some parts (C) to assorted authors.
Generated on Fri Jun 13 22:12:37 2008 for TnFOX by doxygen v1.5.6