VSTGUI 4.5 Graphical User Interface Framework not only for VST plugins

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CSplashScreen Class Reference
Views
Inheritance diagram for CSplashScreen:

## Public Member Functions
| CSplashScreen (const CRect &size, IControlListener *listener, int32_t tag, CBitmap *background, const CRect &toDisplay, const CPoint &offset=CPoint(0, 0))
| CSplashScreen constructor. More...
| CSplashScreen (const CRect &size, IControlListener *listener, int32_t tag, CView *splashView)
| CSplashScreen constructor. More...
| CSplashScreen (const CSplashScreen &splashScreen)
void | draw (CDrawContext *) override
| called if the view should draw itself More...
bool | hitTest (const CPoint &where, const CButtonState &buttons=-1) override
| check if where hits this view More...
CMouseEventResult | onMouseDown (CPoint &where, const CButtonState &buttons) override
| called when a mouse down event occurs More...
CBaseObject * | newCopy () const override
CSplashScreen Methods
virtual void | unSplash ()
virtual void | setDisplayArea (const CRect &rect)
| set the area in which the splash will be displayed More...
virtual CRect & | getDisplayArea (CRect &rect) const
| get the area in which the splash will be displayed More...
Public Member Functions inherited from CControl
| CControl (const CRect &size, IControlListener *listener=nullptr, int32_t tag=0, CBitmap *pBackground=nullptr)
| CControl (const CControl &c)
bool | isDirty () const override
| check if view is dirty More...
void | setDirty (bool val=true) override
| set the view to dirty so that it is redrawn in the next idle. More...
bool | drawFocusOnTop () override
| draw focus before view will be drawn or afterwards More...
bool | getFocusPath (CGraphicsPath &outPath) override
| the graphics path will be drawn filled with the evenodd method and the color set in CFrame::setFocusColor() More...
virtual void | setValue (float val)
virtual float | getValue () const
virtual void | setValueNormalized (float val)
virtual float | getValueNormalized () const
virtual void | setMin (float val)
virtual float | getMin () const
virtual void | setMax (float val)
virtual float | getMax () const
float | getRange () const
virtual void | setOldValue (float val)
virtual float | getOldValue (void) const
virtual void | setDefaultValue (float val)
virtual float | getDefaultValue (void) const
virtual void | bounceValue ()
virtual bool | checkDefaultValue (CButtonState button)
virtual void | valueChanged ()
| notifies listener and dependent objects More...
virtual void | setTag (int32_t val)
virtual int32_t | getTag () const
virtual void | beginEdit ()
virtual void | endEdit ()
bool | isEditing () const
virtual IControlListener * | getListener () const
| get main listener More...
virtual void | setListener (IControlListener *l)
| set main listener More...
void | registerControlListener (IControlListener *listener)
| register a sub listener More...
void | unregisterControlListener (IControlListener *listener)
| unregister a sub listener More...
virtual void | setWheelInc (float val)
virtual float | getWheelInc () const
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 More...
virtual void | onWindowActivate (bool state)
| called when the active state of the window changes More...
void | setTooltipText (UTF8StringPtr text)
virtual CViewContainer * | asViewContainer ()
virtual const CViewContainer * | asViewContainer () const
CMouseEventResult | callMouseListener (MouseListenerCall type, CPoint pos, CButtonState buttons)
void | callMouseListenerEnteredExited (bool mouseEntered)
CMessageResult | notify (CBaseObject *sender, IdStringPtr message) override
void | beforeDelete () override
CBaseObject * | newCopy () const override
virtual CMouseEventResult | onMouseUp (CPoint &where, const CButtonState &buttons)
| called when a mouse up event occurs More...
virtual CMouseEventResult | onMouseMoved (CPoint &where, const CButtonState &buttons)
| called when a mouse move event occurs More...
virtual CMouseEventResult | onMouseCancel ()
| called when mouse tracking should be canceled More...
virtual CMouseEventResult | onMouseEntered (CPoint &where, const CButtonState &buttons)
| called when the mouse enters this view More...
virtual CMouseEventResult | onMouseExited (CPoint &where, const CButtonState &buttons)
| called when the mouse leaves this view More...
void | setHitTestPath (CGraphicsPath *path)
virtual bool | onWheel (const CPoint &where, const float &distance, const CButtonState &buttons)
| called if a mouse wheel event is happening over this view More...
virtual bool | onWheel (const CPoint &where, const CMouseWheelAxis &axis, const float &distance, const CButtonState &buttons)
| called if a mouse wheel event is happening over this view More...
virtual void | setMouseEnabled (bool bEnable=true)
| turn on/off mouse usage for this view More...
bool | getMouseEnabled () const
| get the state of wheather this view uses the mouse or not More...
virtual void | setMouseableArea (const CRect &rect)
| set the area in which the view reacts to the mouse More...
CRect & | getMouseableArea (CRect &rect) const
| get the area in which the view reacts to the mouse More...
const CRect & | getMouseableArea () const
| read only access to the mouseable area More...
bool | doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})
| start a drag operation More...
virtual SharedPointer < IDropTarget > | getDropTarget ()
| get the drag target for drag and drop handling More...
void | setDropTarget (const SharedPointer< IDropTarget > &dt)
| set a custom drop target More...
DragResult | doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
| a drag can only be started from within onMouseDown More...
virtual int32_t | onKeyDown (VstKeyCode &keyCode)
| called if a key down event occurs and this view has focus More...
virtual int32_t | onKeyUp (VstKeyCode &keyCode)
| called if a key up event occurs and this view has focus More...
CCoord | getHeight () const
| get the height of the view More...
CCoord | getWidth () const
| get the width of the view More...
virtual void | setViewSize (const CRect &rect, bool invalid=true)
| set views size More...
const CRect & | getViewSize () const
| read only access to view size More...
virtual CRect | getVisibleViewSize () const
| returns the visible size of the view More...
virtual void | parentSizeChanged ()
| notification that one of the views parent has changed its size More...
virtual CPoint & | frameToLocal (CPoint &point) const
| conversion from frame coordinates to local view coordinates More...
virtual CPoint & | localToFrame (CPoint &point) const
| conversion from local view coordinates to frame coordinates More...
virtual void | setAutosizeFlags (int32_t flags)
| set autosize flags More...
int32_t | getAutosizeFlags () const
| get autosize flags More...
virtual bool | sizeToFit ()
| resize view to optimal size More...
virtual void | looseFocus ()
| called if view should loose focus More...
virtual void | takeFocus ()
| called if view should take focus More...
virtual bool | wantsFocus () const
| check if view supports focus More...
virtual void | setWantsFocus (bool state)
| set focus support on/off More...
bool | getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
| get the size of an attribute More...
bool | getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
| get an attribute More...
bool | setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
| set an attribute More...
bool | removeAttribute (const CViewAttributeID id)
| remove an attribute More...
template<typename T >
bool | setAttribute (const CViewAttributeID id, const T &data)
| set an attribute More...
template<typename T >
bool | getAttribute (const CViewAttributeID id, T &data) const
| get an attribute More...
virtual void | setBackground (CBitmap *background)
| set the background image of this view More...
CBitmap * | getBackground () const
| get the background image of this view More...
virtual void | setDisabledBackground (CBitmap *background)
| set background image used when the mouse is not enabled More...
CBitmap * | getDisabledBackground () const
| get background image used when the mouse is not enabled More...
CBitmap * | getDrawBackground () const
| get the bitmap which is drawn depending on the enabled state. More...
virtual void | setTransparency (bool val)
| set views transparent state More...
bool | getTransparency () const
| get views transparent state More...
virtual void | setAlphaValue (float alpha)
| set alpha value which will be applied when drawing this view More...
float | getAlphaValue () const
| get alpha value More...
virtual bool | removed (CView *parent)
| view is removed from parent view More...
virtual bool | attached (CView *parent)
| view is attached to a parent view More...
bool | isAttached () const
| is view attached to a parentView More...
CView * | getParentView () const
| get parent view More...
CFrame * | getFrame () const
| get frame More...
virtual VSTGUIEditorInterface * | getEditor () const
| get editor More...
void | addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, CBaseObject *notificationObject=nullptr)
void | addAnimation (IdStringPtr name, Animation::IAnimationTarget *target, Animation::ITimingFunction *timingFunction, const Animation::DoneFunction &doneFunc)
void | removeAnimation (IdStringPtr name)
void | removeAllAnimations ()
void | registerViewListener (IViewListener *listener)
void | unregisterViewListener (IViewListener *listener)
void | registerViewMouseListener (IViewMouseListener *listener)
void | unregisterViewMouseListener (IViewMouseListener *listener)
CGraphicsTransform | getGlobalTransform () const
| get the active global transform for this view More...
template<typename T >
T & | translateToGlobal (T &t) const
| translates a local coordinate to a global one using parent transforms More...
template<typename T >
T | translateToGlobal (const T &t) const
| translates a local coordinate to a global one using parent transforms More...
template<typename T >
T & | translateToLocal (T &t) const
| translates a global coordinate to a local one using parent transforms More...
template<typename T >
T | translateToLocal (const T &t) const
| translates a local coordinate to a global one using parent transforms More...
virtual void | drawRect (CDrawContext *pContext, const CRect &updateRect)
| called if the view should draw itself More...
virtual bool | checkUpdate (const CRect &updateRect) const
virtual void | invalidRect (const CRect &rect)
| mark rect as invalid More...
virtual void | invalid ()
| mark whole view as invalid More...
virtual void | setVisible (bool state)
| set visibility state More...
bool | isVisible () const
| get visibility state More...
virtual void | onIdle ()
| called on idle when view wants idle More...
void | setWantsIdle (bool state)
| enable/disable onIdle() callback More...
bool | wantsIdle () const
| returns if the view wants idle callback or not More...
Public Member Functions inherited from CBaseObject
| CBaseObject ()=default
| ~CBaseObject () noexceptoverride=default
| CBaseObject (const CBaseObject &o)
CBaseObject & | operator= (const CBaseObject &obj)
Public Member Functions inherited from ReferenceCounted< T >
| ReferenceCounted ()=default
virtual | ~ReferenceCounted () noexcept=default
| ReferenceCounted (const ReferenceCounted &)
ReferenceCounted & | operator= (const ReferenceCounted &)
void | forget () override
| decrease refcount and delete object if refcount == 0 More...
void | remember () override
| increase refcount More...
virtual int32_t | getNbReference () const
| get refcount More...
Public Member Functions inherited from IFocusDrawing
virtual | ~IFocusDrawing () noexcept=default
Public Member Functions inherited from IDependency
virtual void | addDependency (CBaseObject *obj)
| add a dependent object More...
virtual void | removeDependency (CBaseObject *obj)
| remove a dependent object. More...
virtual void | changed (IdStringPtr message)
| notify dependent objects of change with message. More...
virtual void | deferChanges (bool state)
| defer changes until later. More...
Public Member Functions inherited from IControlListener
virtual | ~IControlListener () noexcept=default
virtual int32_t | controlModifierClicked (CControl *pControl, CButtonState button)
| return 1 if you want the control to not handle it, otherwise 0 More...
virtual void | controlBeginEdit (CControl *pControl)
virtual void | controlEndEdit (CControl *pControl)
virtual void | controlTagWillChange (CControl *pControl)
virtual void | controlTagDidChange (CControl *pControl)

## Protected Member Functions
| ~CSplashScreen () noexceptoverride
void | valueChanged (CControl *pControl) override
Protected Member Functions inherited from CControl
| ~CControl () noexceptoverride=default
Protected Member Functions inherited from CView
| ~CView () noexceptoverride
CGraphicsPath * | getHitTestPath () 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 Member Functions inherited from IDependency
| IDependency ()=default
virtual | ~IDependency () noexcept

## Protected Attributes
CRect | toDisplay
CRect | keepSize
CPoint | offset
CView * | modalView {nullptr}
ModalViewSession * | modalViewSession {nullptr}
Protected Attributes inherited from CControl
IControlListener * | listener
SubListenerDispatcher | subListeners
int32_t | tag
float | oldValue
float | defaultValue
float | value
float | vmin
float | vmax
float | wheelInc
int32_t | editing
Protected Attributes inherited from IDependency
int32_t | deferChangeCount {0}
DeferedChangesSet | deferedChanges
DependentList | dependents

## Additional Inherited Members
Public Types inherited from CView
enum | MouseListenerCall { MouseDown, MouseMoved, MouseUp, MouseCancel }
Static Public Attributes inherited from CControl
static int32_t | kZoomModifier = kShift
| zoom modifier key, per default is the shift key More...
static int32_t | kDefaultValueModifier = kControl
| default value modifier key, per default is the control key More...
static IdStringPtr | kMessageValueChanged = "kMessageValueChanged"
static IdStringPtr | kMessageBeginEdit = "kMessageBeginEdit"
static IdStringPtr | kMessageEndEdit = "kMessageEndEdit"
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. More...
static uint32_t | idleRate
| global idle rate in Hz, defaults to 30 Hz More...
Protected Types inherited from CControl
using | SubListenerDispatcher = DispatchList< IControlListener * >
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, kLastCViewFlag = 7 }
Protected Types inherited from IDependency
using | DeferedChangesSet = std::set< IdStringPtr >
using | DependentList = std::list< CBaseObject * >
Static Protected Member Functions inherited from CControl
static int32_t | mapVstKeyModifier (int32_t vstModifier)
Static Protected Member Functions inherited from IDependency
static void | rememberObject (CBaseObject *obj)
static void | forgetObject (CBaseObject *obj)

## Detailed Description

One click on its activated region and its bitmap or view is displayed, in this state the other controls can not be used, and another click on the displayed area will leave the modal mode.

## Constructor & Destructor Documentation

CSplashScreen | ( | const CRect & | size,
|  | IControlListener * | listener,
|  | int32_t | tag,
|  | CBitmap * | background,
|  | const CRect & | toDisplay,
|  | const CPoint & | offset = `CPoint (0, 0)`
| ) |  |

CSplashScreen constructor.

Parameters

  size | the size of this view
  listener | the listener
  tag | the control tag
  background | the bitmap
  toDisplay | the region where to display the bitmap
  offset | offset of background bitmap

CSplashScreen | ( | const CRect & | size,
|  | IControlListener * | listener,
|  | int32_t | tag,
|  | CView * | splashView
| ) |  |

CSplashScreen constructor.

Parameters

  size | the size of this view
  listener | the listener
  tag | the control tag
  splashView | the view to show

CSplashScreen | ( | const CSplashScreen & | splashScreen | ) |

~CSplashScreen | ( |  | ) |
| override protected noexcept

## Member Function Documentation

void draw | ( | CDrawContext * | pContext | ) |
| override virtual

called if the view should draw itself

Parameters

  pContext | draw context in which to draw

Implements CControl.

Reimplemented in CAnimationSplashScreen.

virtual CRect& getDisplayArea | ( | CRect & | rect | ) | const
| inline virtual

get the area in which the splash will be displayed

bool hitTest | ( | const CPoint & | where,
|  | const CButtonState & | buttons = `-1`
| ) |  |
| override virtual

check if where hits this view

Parameters

  where | location
  buttons | button and modifier state

Returns
  true if point hits this view

Reimplemented from CView.

CBaseObject* newCopy | ( |  | ) | const
| inline override virtual

Implements CControl.

CMouseEventResult onMouseDown | ( | CPoint & | where,
|  | const CButtonState & | buttons
| ) |  |
| override virtual

called when a mouse down event occurs

Parameters

  where | mouse location of mouse down
  buttons | button and modifier state

Returns
  event result. see CMouseEventResult

Reimplemented from CView.

Reimplemented in CAnimationSplashScreen.

virtual void setDisplayArea | ( | const CRect & | rect | ) |
| inline virtual

set the area in which the splash will be displayed

void unSplash | ( |  | ) |
| virtual

Reimplemented in CAnimationSplashScreen.

void valueChanged | ( | CControl * | pControl | ) |
| override protected virtual

Implements IControlListener.

## Member Data Documentation

CRect keepSize
| protected

CView* modalView {nullptr}
| protected

ModalViewSession* modalViewSession {nullptr}
| protected

CPoint offset
| protected

CRect toDisplay
| protected

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

- csplashscreen.h
- csplashscreen.cpp