VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CGradientView Class Reference

View which draws a gradient. More...

+ Inheritance diagram for CGradientView:

Public Member Functions

 CGradientView (const CRect &size)
 
 ~CGradientView () noexceptoverride=default
 
void setViewSize (const CRect &rect, bool invalid=true) override
 set views size
 
void draw (CDrawContext *context) override
 called if the view should draw itself
 
- Public Member Functions inherited from CView
 CView (const CRect &size)
 
 CView (const CView &view)
 
void setSubviewState (bool state)
 
bool isSubview () const
 
virtual bool wantsWindowActiveStateChangeNotification () const
 whether this view wants to be informed if the window's active state changes
 
virtual void onWindowActivate (bool state)
 called when the active state of the window changes
 
void setTooltipText (UTF8StringPtr text)
 
virtual CViewContainerasViewContainer ()
 
virtual const CViewContainerasViewContainer () const
 
CMouseEventResult callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
 
void callMouseListenerEnteredExited (bool mouseEntered)
 
CMessageResult notify (CBaseObject *sender, IdStringPtr message) override
 
void beforeDelete () override
 
CBaseObjectnewCopy () const override
 
virtual void dispatchEvent (Event &event)
 dispatch an event
 
virtual void onMouseDownEvent (MouseDownEvent &event)
 called when a mouse down event occurs
 
virtual void onMouseMoveEvent (MouseMoveEvent &event)
 called when a mouse move event occurs
 
virtual void onMouseUpEvent (MouseUpEvent &event)
 called when a mouse up event occurs
 
virtual void onMouseCancelEvent (MouseCancelEvent &event)
 called when mouse tracking should be canceled
 
virtual void onMouseEnterEvent (MouseEnterEvent &event)
 called when the mouse enters this view
 
virtual void onMouseExitEvent (MouseExitEvent &event)
 called when the mouse leaves this view
 
virtual void onMouseWheelEvent (MouseWheelEvent &event)
 called when a mouse wheel event occurs
 
virtual void onZoomGestureEvent (ZoomGestureEvent &event)
 called when a zoom gesture event occurs
 
virtual void setMouseEnabled (bool bEnable=true)
 turn on/off mouse usage for this view
 
bool getMouseEnabled () const
 get the state of wheather this view uses the mouse or not
 
virtual void setMouseableArea (const CRect &rect)
 set the area in which the view reacts to the mouse
 
CRect getMouseableArea () const
 get the area in which the view reacts to the mouse
 
virtual CMouseEventResult onMouseDown (CPoint &where, const CButtonState &buttons)
 do not use any longer.
 
virtual CMouseEventResult onMouseUp (CPoint &where, const CButtonState &buttons)
 do not use any longer.
 
virtual CMouseEventResult onMouseMoved (CPoint &where, const CButtonState &buttons)
 do not use any longer.
 
virtual CMouseEventResult onMouseCancel ()
 do not use any longer.
 
virtual CMouseEventResult onMouseEntered (CPoint &where, const CButtonState &buttons)
 do not use any longer.
 
virtual CMouseEventResult onMouseExited (CPoint &where, const CButtonState &buttons)
 do not use any longer.
 
virtual bool onWheel (const CPoint &where, const float &distance, const CButtonState &buttons) final
 
virtual bool onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
 
CRectgetMouseableArea (CRect &rect) const
 get the area in which the view reacts to the mouse
 
void setHitTestPath (CGraphicsPath *path)
 
virtual bool hitTest (const CPoint &where, const Event &event=noEvent())
 check if where hits this view
 
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
 A drag can only be started from within onMouseDown or onMouseMove.
 
virtual SharedPointer
< IDropTarget
getDropTarget ()
 get the drag target for drag and drop handling
 
void setDropTarget (const SharedPointer< IDropTarget > &dt)
 set a custom drop target
 
DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
 a drag can only be started from within onMouseDown
 
virtual void onKeyboardEvent (KeyboardEvent &event)
 called when a keyboard event is dispatched to this view
 
virtual int32_t onKeyDown (VstKeyCode &keyCode)
 called if a key down event occurs and this view has focus
 
virtual int32_t onKeyUp (VstKeyCode &keyCode)
 called if a key up event occurs and this view has focus
 
CCoord getHeight () const
 get the height of the view
 
CCoord getWidth () const
 get the width of the view
 
const CRectgetViewSize () const
 read only access to view size
 
virtual CRect getVisibleViewSize () const
 returns the visible size of the view
 
virtual void parentSizeChanged ()
 notification that one of the views parent has changed its size
 
virtual CPointframeToLocal (CPoint &point) const
 conversion from frame coordinates to local view coordinates
 
virtual CPointlocalToFrame (CPoint &point) const
 conversion from local view coordinates to frame coordinates
 
virtual void setAutosizeFlags (int32_t flags)
 set autosize flags
 
int32_t getAutosizeFlags () const
 get autosize flags
 
virtual bool sizeToFit ()
 resize view to optimal size
 
virtual void looseFocus ()
 called if view should loose focus
 
virtual void takeFocus ()
 called if view should take focus
 
virtual bool wantsFocus () const
 check if view supports focus
 
virtual void setWantsFocus (bool state)
 set focus support on/off
 
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
 get the size of an attribute
 
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
 get an attribute
 
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
 set an attribute
 
bool removeAttribute (const CViewAttributeID id)
 remove an attribute
 
template<typename T >
bool setAttribute (const CViewAttributeID id, const T &data)
 set an attribute
 
template<typename T >
bool getAttribute (const CViewAttributeID id, T &data) const
 get an attribute
 
virtual void setBackground (CBitmap *background)
 set the background image of this view
 
CBitmapgetBackground () const
 get the background image of this view
 
virtual void setDisabledBackground (CBitmap *background)
 set background image used when the mouse is not enabled
 
CBitmapgetDisabledBackground () const
 get background image used when the mouse is not enabled
 
CBitmapgetDrawBackground () const
 get the bitmap which is drawn depending on the enabled state.
 
virtual void setTransparency (bool val)
 set views transparent state
 
bool getTransparency () const
 get views transparent state
 
virtual void setAlphaValue (float alpha)
 set alpha value which will be applied when drawing this view
 
float getAlphaValue () const
 get alpha value
 
virtual bool removed (CView *parent)
 view is removed from parent view
 
virtual bool attached (CView *parent)
 view is attached to a parent view
 
bool isAttached () const
 is view attached to a parentView
 
CViewgetParentView () const
 get parent view
 
CFramegetFrame () const
 get frame
 
virtual VSTGUIEditorInterfacegetEditor () const
 get editor
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject)
 
void addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc=nullptr, bool callDoneOnCancel=false)
 
void removeAnimation (IdStringPtr name)
 
void removeAllAnimations ()
 
void registerViewListener (IViewListener *listener)
 
void unregisterViewListener (IViewListener *listener)
 
void registerViewEventListener (IViewEventListener *listener)
 
void unregisterViewEventListener (IViewEventListener *listener)
 
void registerViewMouseListener (IViewMouseListener *listener)
 
void unregisterViewMouseListener (IViewMouseListener *listener)
 
CGraphicsTransform getGlobalTransform (bool ignoreFrame=false) const
 get the active global transform for this view
 
template<typename T >
T & translateToGlobal (T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
translateToGlobal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms
 
template<typename T >
T & translateToLocal (T &t, bool ignoreFrame=false) const
 translates a global coordinate to a local one using parent transforms
 
template<typename T >
translateToLocal (const T &t, bool ignoreFrame=false) const
 translates a local coordinate to a global one using parent transforms
 
virtual void drawRect (CDrawContext *pContext, const CRect &updateRect)
 called if the view should draw itself
 
virtual bool checkUpdate (const CRect &updateRect) const
 
virtual bool isDirty () const
 check if view is dirty
 
virtual void setDirty (bool val=true)
 set the view to dirty so that it is redrawn in the next idle.
 
virtual void invalidRect (const CRect &rect)
 mark rect as invalid
 
virtual void invalid ()
 mark whole view as invalid
 
virtual void setVisible (bool state)
 set visibility state
 
bool isVisible () const
 get visibility state
 
virtual void onIdle ()
 called on idle when view wants idle
 
void setWantsIdle (bool state)
 enable/disable onIdle() callback
 
bool wantsIdle () const
 returns if the view wants idle callback or not
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()=default
 
 ~CBaseObject () noexceptoverride=default
 
 CBaseObject (const CBaseObject &)
 
CBaseObjectoperator= (const CBaseObject &)
 
virtual CMessageResult notify ([[maybe_unused]] CBaseObject *sender,[[maybe_unused]] IdStringPtr message)
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 

Protected Member Functions

virtual void attributeChanged ()
 
- Protected Member Functions inherited from CView
 ~CView () noexceptoverride
 
CGraphicsPathgetHitTestPath () const
 
bool hasViewFlag (int32_t bit) const
 
void setViewFlag (int32_t bit, bool state)
 
void setAlphaValueNoInvalidate (float value)
 
void setParentFrame (CFrame *frame)
 
void setParentView (CView *parent)
 

Protected Attributes

GradientStyle gradientStyle {kLinearGradient}
 
CColor frameColor {kBlackCColor}
 
double gradientAngle {0.}
 
CCoord roundRectRadius {5.}
 
CCoord frameWidth {1.}
 
CCoord radialRadius {1.}
 
CPoint radialCenter {0.5, 0.5}
 
bool drawAntialiased {true}
 
SharedPointer< CGraphicsPathpath
 
SharedPointer< CGradientgradient
 

Gradient Style Methods

enum  GradientStyle { kLinearGradient, kRadialGradient }
 
void setGradientStyle (GradientStyle style)
 
void setGradient (CGradient *gradient)
 
void setFrameColor (const CColor &newColor)
 
void setGradientAngle (double angle)
 
void setRoundRectRadius (CCoord radius)
 
void setFrameWidth (CCoord width)
 
void setDrawAntialiased (bool state)
 
void setRadialCenter (const CPoint &center)
 
void setRadialRadius (CCoord radius)
 
GradientStyle getGradientStyle () const
 
CGradientgetGradient () const
 
const CColorgetFrameColor () const
 
double getGradientAngle () const
 
CCoord getRoundRectRadius () const
 
CCoord getFrameWidth () const
 
bool getDrawAntialised () const
 
const CPointgetRadialCenter () const
 
CCoord getRadialRadius () const
 

Additional Inherited Members

- Public Types inherited from CView
enum  MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }
 
- Static Public Attributes inherited from CView
static bool kDirtyCallAlwaysOnMainThread = false
 if this is true, setting a view dirty will call invalid() instead of checking it in idle.
 
static uint32_t idleRate = 30
 global idle rate in Hz, defaults to 30 Hz
 
- Protected Types inherited from CView
enum  {
  kMouseEnabled = 1 << 0, kTransparencyEnabled = 1 << 1, kWantsFocus = 1 << 2, kIsAttached = 1 << 3,
  kVisible = 1 << 4, kDirty = 1 << 5, kWantsIdle = 1 << 6, kIsSubview = 1 << 7,
  kHasAlpha = 1 << 8, kHasBackground = 1 << 9, kHasDisabledBackground = 1 << 10, kHasMouseableArea = 1 << 11,
  kLastCViewFlag = 11
}
 

Detailed Description

View which draws a gradient.

Member Enumeration Documentation

Enumerator
kLinearGradient 
kRadialGradient 

Constructor & Destructor Documentation

CGradientView ( const CRect size)
explicit
~CGradientView ( )
overridedefaultnoexcept

Member Function Documentation

void attributeChanged ( )
protectedvirtual
void draw ( CDrawContext pContext)
overridevirtual

called if the view should draw itself

Parameters
pContextdraw context in which to draw

Reimplemented from CView.

bool getDrawAntialised ( ) const
inline
const CColor& getFrameColor ( ) const
inline
CCoord getFrameWidth ( ) const
inline
CGradient* getGradient ( ) const
inline
double getGradientAngle ( ) const
inline
GradientStyle getGradientStyle ( ) const
inline
const CPoint& getRadialCenter ( ) const
inline
CCoord getRadialRadius ( ) const
inline
CCoord getRoundRectRadius ( ) const
inline
void setDrawAntialiased ( bool  state)
void setFrameColor ( const CColor newColor)
void setFrameWidth ( CCoord  width)
void setGradient ( CGradient gradient)
void setGradientAngle ( double  angle)
void setGradientStyle ( GradientStyle  style)
void setRadialCenter ( const CPoint center)
void setRadialRadius ( CCoord  radius)
void setRoundRectRadius ( CCoord  radius)
void setViewSize ( const CRect newSize,
bool  doInvalid = true 
)
overridevirtual

set views size

Parameters
newSizerect of new size of view
doInvalidif true set view dirty

Reimplemented from CView.

Member Data Documentation

bool drawAntialiased {true}
protected
CColor frameColor {kBlackCColor}
protected
CCoord frameWidth {1.}
protected
SharedPointer<CGradient> gradient
protected
double gradientAngle {0.}
protected
GradientStyle gradientStyle {kLinearGradient}
protected
SharedPointer<CGraphicsPath> path
protected
CPoint radialCenter {0.5, 0.5}
protected
CCoord radialRadius {1.}
protected
CCoord roundRectRadius {5.}
protected

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