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

FX::FXGradientBar Class Reference

#include <FXGradientBar.h>

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

Public Types

enum  {
  ID_LOWER_COLOR =FXFrame::ID_LAST,
  ID_UPPER_COLOR,
  ID_BLEND_LINEAR,
  ID_BLEND_POWER,
  ID_BLEND_SINE,
  ID_BLEND_INCREASING,
  ID_BLEND_DECREASING,
  ID_RECENTER,
  ID_SPLIT,
  ID_MERGE,
  ID_UNIFORM,
  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

 FXGradientBar (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, 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)
 
virtual void create ()
 
virtual void layout ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
FXint getSegment (FXint x, FXint y) const
 
FXint getGrip (FXint sg, FXint x, FXint y) const
 
FXint getNumSegments () const
 
void setGradients (const FXGradient *segments, FXint nsegments)
 
void getGradients (FXGradient *&segments, FXint &nsegments) const
 
void setCurrentSegment (FXint index, FXbool notify=FALSE)
 
FXint getCurrentSegment () const
 
void setAnchorSegment (FXint index)
 
FXint getAnchorSegment () const
 
FXbool selectSegments (FXint fm, FXint to, FXbool notify=FALSE)
 
FXbool deselectSegments (FXbool notify)
 
FXbool isSegmentSelected (FXint s) const
 
void setSegmentLowerColor (FXint s, FXColor clr, FXbool notify=FALSE)
 
void setSegmentUpperColor (FXint s, FXColor clr, FXbool notify=FALSE)
 
FXColor getSegmentLowerColor (FXint s) const
 
FXColor getSegmentUpperColor (FXint s) const
 
void moveSegmentLower (FXint sg, FXdouble val, FXbool notify=FALSE)
 
void moveSegmentMiddle (FXint sg, FXdouble val, FXbool notify=FALSE)
 
void moveSegmentUpper (FXint sg, FXdouble val, FXbool notify=FALSE)
 
void moveSegments (FXint sglo, FXint sghi, FXdouble val, FXbool notify=FALSE)
 
FXdouble getSegmentLower (FXint sg) const
 
FXdouble getSegmentMiddle (FXint sg) const
 
FXdouble getSegmentUpper (FXint sg) const
 
void gradient (FXColor *ramp, FXint nramp)
 
FXuint getSegmentBlend (FXint s) const
 
void splitSegments (FXint sglo, FXint sghi, FXbool notify=FALSE)
 
void mergeSegments (FXint sglo, FXint sghi, FXbool notify=FALSE)
 
void uniformSegments (FXint sglo, FXint sghi, FXbool notify=FALSE)
 
void blendSegments (FXint sglo, FXint sghi, FXuint blend=GRADIENT_BLEND_LINEAR, FXbool notify=FALSE)
 
FXuint getBarStyle () const
 
void setBarStyle (FXuint style)
 
void setSelectColor (FXColor clr)
 
FXColor getSelectColor () const
 
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 ~FXGradientBar ()
 
- 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 detach ()
 
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 gradient bar is a control that is used to edit color gradient, such as used in texture mapping and shape filling.

See also:

Member Enumeration Documentation

anonymous enum
Enumerator
ID_LOWER_COLOR 
ID_UPPER_COLOR 
ID_BLEND_LINEAR 
ID_BLEND_POWER 
ID_BLEND_SINE 
ID_BLEND_INCREASING 
ID_BLEND_DECREASING 
ID_RECENTER 
ID_SPLIT 
ID_MERGE 
ID_UNIFORM 
ID_LAST 

Constructor & Destructor Documentation

FX::FXGradientBar::FXGradientBar ( FXComposite p,
FXObject tgt = NULL,
FXSelector  sel = 0,
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 
)

Construct a gradient bar.

virtual FX::FXGradientBar::~FXGradientBar ( )
virtual

Destructor.

Member Function Documentation

virtual void FX::FXGradientBar::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXWindow.

virtual void FX::FXGradientBar::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXGradientBar::getDefaultWidth ( )
virtual

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXGradientBar::getDefaultHeight ( )
virtual

Return default height.

Reimplemented from FX::FXFrame.

FXint FX::FXGradientBar::getSegment ( FXint  x,
FXint  y 
) const

Obtain segment containing location x, y.

Returns -1 if no matching segment was found.

FXint FX::FXGradientBar::getGrip ( FXint  sg,
FXint  x,
FXint  y 
) const

Get the grip in segment sg which is closest to location (x, y), one of GRIP_LOWER, GRIP_SEG_LOWER, GRIP_MIDDLE, GRIP_SEG_UPPER, GRIP_UPPER or GRIP_NONE.

FXint FX::FXGradientBar::getNumSegments ( ) const
inline

Return the number of segments.

void FX::FXGradientBar::setGradients ( const FXGradient segments,
FXint  nsegments 
)

Replace the current gradient segments.

The gradient bar makes a copy of the input segments array.

void FX::FXGradientBar::getGradients ( FXGradient *&  segments,
FXint nsegments 
) const

Return a copy of the gradient segments.

The array of segments is allocated using FXMALLOC and should be freed by the caller using FXFREE.

void FX::FXGradientBar::setCurrentSegment ( FXint  index,
FXbool  notify = FALSE 
)

Change current segment.

FXint FX::FXGradientBar::getCurrentSegment ( ) const
inline

Return current segment, or -1 if there is no current segment.

void FX::FXGradientBar::setAnchorSegment ( FXint  index)

Change anchor segment.

FXint FX::FXGradientBar::getAnchorSegment ( ) const
inline

Return anchor segment, or -1 if there is no anchor segment.

FXbool FX::FXGradientBar::selectSegments ( FXint  fm,
FXint  to,
FXbool  notify = FALSE 
)

Select segment(s)

FXbool FX::FXGradientBar::deselectSegments ( FXbool  notify)

Deselect all segments.

FXbool FX::FXGradientBar::isSegmentSelected ( FXint  s) const

Returns TRUE if the specified segment is selected.

void FX::FXGradientBar::setSegmentLowerColor ( FXint  s,
FXColor  clr,
FXbool  notify = FALSE 
)

Set lower color of a segment.

void FX::FXGradientBar::setSegmentUpperColor ( FXint  s,
FXColor  clr,
FXbool  notify = FALSE 
)

Set upper color of a segment.

FXColor FX::FXGradientBar::getSegmentLowerColor ( FXint  s) const

Get lower color of a segment.

FXColor FX::FXGradientBar::getSegmentUpperColor ( FXint  s) const

Get upper color of a segment.

void FX::FXGradientBar::moveSegmentLower ( FXint  sg,
FXdouble  val,
FXbool  notify = FALSE 
)

Move lower point of segment sg.

void FX::FXGradientBar::moveSegmentMiddle ( FXint  sg,
FXdouble  val,
FXbool  notify = FALSE 
)

Move middle point of segment sg.

void FX::FXGradientBar::moveSegmentUpper ( FXint  sg,
FXdouble  val,
FXbool  notify = FALSE 
)

Move upper point of segment sg.

void FX::FXGradientBar::moveSegments ( FXint  sglo,
FXint  sghi,
FXdouble  val,
FXbool  notify = FALSE 
)

Move segments sglo to sghi to new position val.

FXdouble FX::FXGradientBar::getSegmentLower ( FXint  sg) const

Get lower value of segment sg.

FXdouble FX::FXGradientBar::getSegmentMiddle ( FXint  sg) const

Get middle value of segment sg.

FXdouble FX::FXGradientBar::getSegmentUpper ( FXint  sg) const

Get upper value of segment sg.

void FX::FXGradientBar::gradient ( FXColor ramp,
FXint  nramp 
)

Get gradient ramp.

The ramp argument should be an array of size nramp, which will be filled with the appropriate color values.

FXuint FX::FXGradientBar::getSegmentBlend ( FXint  s) const

Get blend mode of segment, one of GRADIENT_BLEND_LINEAR, GRADIENT_BLEND_POWER, GRADIENT_BLEND_SINE, GRADIENT_BLEND_INCREASING, or GRADIENT_BLEND_DECREASING.

void FX::FXGradientBar::splitSegments ( FXint  sglo,
FXint  sghi,
FXbool  notify = FALSE 
)

Split segment at the midpoint.

void FX::FXGradientBar::mergeSegments ( FXint  sglo,
FXint  sghi,
FXbool  notify = FALSE 
)

Merge segments.

void FX::FXGradientBar::uniformSegments ( FXint  sglo,
FXint  sghi,
FXbool  notify = FALSE 
)

Make segments uniformly distributed.

void FX::FXGradientBar::blendSegments ( FXint  sglo,
FXint  sghi,
FXuint  blend = GRADIENT_BLEND_LINEAR,
FXbool  notify = FALSE 
)

Change blend mode of segment.

FXuint FX::FXGradientBar::getBarStyle ( ) const

Get the gradient bar style.

void FX::FXGradientBar::setBarStyle ( FXuint  style)

Change the gradient bar style.

void FX::FXGradientBar::setSelectColor ( FXColor  clr)

Set color.

FXColor FX::FXGradientBar::getSelectColor ( ) const
inline

Get color.

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

Set status line help text for this gradient bar.

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

Get status line help text for this gradient bar.

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

Set tool tip message for this gradient bar.

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

Get tool tip message for this gradient bar.

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

Save gradient bar to a stream.

Reimplemented from FX::FXFrame.

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

Load gradient bar from a stream.

Reimplemented from FX::FXFrame.

Copyright © 1997-2005 Jeroen van der Zijp