![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXScrollBar.h>
Public Types | |
enum | { ID_TIMEWHEEL =FXWindow::ID_LAST, ID_AUTOSCROLL, 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 | |
FXScrollBar (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=SCROLLBAR_VERTICAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0) | |
virtual FXint | getDefaultWidth () |
virtual FXint | getDefaultHeight () |
virtual void | layout () |
void | setRange (FXint r) |
FXint | getRange () const |
void | setPage (FXint p) |
FXint | getPage () const |
void | setLine (FXint l) |
FXint | getLine () const |
void | setPosition (FXint p) |
FXint | getPosition () const |
void | setHiliteColor (FXColor clr) |
FXColor | getHiliteColor () const |
void | setShadowColor (FXColor clr) |
FXColor | getShadowColor () const |
void | setBorderColor (FXColor clr) |
FXColor | getBorderColor () const |
void | setArrowColor (FXColor clr) |
FXColor | getArrowColor () const |
void | setScrollBarStyle (FXuint style) |
FXuint | getScrollBarStyle () const |
void | setBarSize (FXint size) |
FXint | getBarSize () const |
virtual void | save (FXStream &store) const |
virtual void | load (FXStream &store) |
virtual | ~FXScrollBar () |
![]() | |
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 | create () |
virtual void | attach (FXID w) |
virtual void | detach () |
virtual void | destroy () |
virtual void | setShape (const FXRegion ®ion) |
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 FXchar * | tr (const FXchar *message, const FXchar *hint=NULL) const |
virtual | ~FXWindow () |
![]() | |
FXint | getWidth () const |
FXint | getHeight () const |
FXVisual * | getVisual () const |
void | setVisual (FXVisual *vis) |
virtual | ~FXDrawable () |
![]() | |
FXApp * | getApp () const |
FXID | id () const |
void | setUserData (void *ptr) |
void * | getUserData () const |
virtual | ~FXId () |
![]() | |
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 | |
![]() | |
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 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 [] |
The scroll bar is used when a document has a larger content than may be made visible.
The range is the total size of the document, the page is the part of the document which is visible. The size of the scrollbar thumb is adjusted to give feedback of the relative sizes of each. The scroll bar may be manipulated by the left mouse button (normal scrolling), by the middle mouse button (same as the left mouse only the scroll position can jump to the place where the click is made), or by the right mouse button (vernier- or fine-scrolling). Holding down the control key while scrolling with the left or middle mouse button also enables vernier-scrolling mode. The vernier-scrolling mode is very useful for accurate positioning in large documents. Finally, if the mouse sports a wheel, the scroll bar can be manipulated by means of the mouse wheel as well. Holding down the Control-key during wheel motion will cause the scrolling to go faster than normal. While moving the scroll bar, a message of type SEL_CHANGED will be sent to the target, and the message data will reflect the current position of type FXint. At the end of the interaction, the scroll bar will send a message of type SEL_COMMAND to notify the target of the final position.
See also:
FX::FXScrollBar::FXScrollBar | ( | FXComposite * | p, |
FXObject * | tgt = NULL , |
||
FXSelector | sel = 0 , |
||
FXuint | opts = SCROLLBAR_VERTICAL , |
||
FXint | x = 0 , |
||
FXint | y = 0 , |
||
FXint | w = 0 , |
||
FXint | h = 0 |
||
) |
Construct scroll bar.
|
virtual |
Destructor.
|
virtual |
Return default width.
Reimplemented from FX::FXWindow.
|
virtual |
Return default height.
Reimplemented from FX::FXWindow.
|
virtual |
Perform layout.
Reimplemented from FX::FXWindow.
void FX::FXScrollBar::setRange | ( | FXint | r | ) |
Set content size range.
|
inline |
Return content size range.
void FX::FXScrollBar::setPage | ( | FXint | p | ) |
Set viewport page size.
|
inline |
Return page size.
void FX::FXScrollBar::setLine | ( | FXint | l | ) |
Set scoll increment for line.
|
inline |
Return line increment.
void FX::FXScrollBar::setPosition | ( | FXint | p | ) |
Change scroll position.
|
inline |
Return current scroll position.
void FX::FXScrollBar::setHiliteColor | ( | FXColor | clr | ) |
Change highlight color.
|
inline |
Return highlight color.
void FX::FXScrollBar::setShadowColor | ( | FXColor | clr | ) |
Change the shadow color.
|
inline |
Return the shadow color.
void FX::FXScrollBar::setBorderColor | ( | FXColor | clr | ) |
Change the border color.
|
inline |
Return the border color.
void FX::FXScrollBar::setArrowColor | ( | FXColor | clr | ) |
Change the arrow color.
|
inline |
Return the arrow color.
void FX::FXScrollBar::setScrollBarStyle | ( | FXuint | style | ) |
Change the scrollbar style.
FXuint FX::FXScrollBar::getScrollBarStyle | ( | ) | const |
Return the scrollbar style.
void FX::FXScrollBar::setBarSize | ( | FXint | size | ) |
Change the bar size.
|
inline |
Return the bar size.
|
virtual |
Save to stream.
Reimplemented from FX::FXWindow.
|
virtual |
Load from stream.
Reimplemented from FX::FXWindow.
![]() |