VSTGUI: VSTGUI Namespace Reference

VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
VSTGUI Namespace Reference

## Namespaces
namespace | Animation
namespace | BitmapFilter
namespace | Call
namespace | CClipboardDetail
namespace | CDrawMethods
namespace | Constants
namespace | Detail
namespace | EventPrivate
namespace | ExternalView
namespace | Layouting
namespace | PixelBuffer
namespace | Standalone
| Standalone Library
namespace | String
namespace | UIDescriptionPrivate
namespace | UIViewCreator
namespace | VST3EditorInternal
namespace | Xml

## Classes
class | AEffGUIEditor
class | AspectRatioVST3Editor
| An extended VST3 Editor which scales its contents when resized. More...
class | Base64Codec
struct | BitScopeToggleT
class | Buffer
class | BufferedOutputStream
class | CAnimationSplashScreen
| a splash screen which animates the opening and closing of the splash bitmap More...
class | CAnimKnob
| a bitmap knob control More...
class | CAutoAnimation
class | CAutoLayoutContainerView
| TODO: Doc. More...
class | CBaseObject
| Base Object with reference counter. More...
class | CBaseObjectGuard
class | CBitmap
| Encapsulates various platform depended kinds of bitmaps. More...
class | CBitmapPixelAccess
| direct pixel access to a CBitmap More...
struct | CButtonState
| Button and Modifier state. More...
class | CCheckBox
| a check box control with a title and 3 states More...
struct | CClipboard
struct | CColor
| RGBA Color structure. More...
class | CColorChooser
struct | CColorChooserUISettings
class | CCommandMenuItem
| a command menu item More...
class | CControl
| base class of all VSTGUI controls More...
class | CDataBrowser
| DataBrowser view. More...
class | CDragContainerHelper
| Helper class to port old code which used CDragContainer. More...
class | CDrawContext
| A drawing context encapsulates the drawing context of the underlying OS. More...
struct | CDrawMode
class | CDropSource
| drop source More...
class | CExternalControl
class | CExternalView
| View to embed non CView views into VSTGUI. More...
struct | CExternalViewBaseImpl
class | CFileExtension
| file extension description More...
class | CFileStream
| File input and output stream. More...
class | CFontChooser
struct | CFontChooserUIDefinition
class | CFontDesc
| font class More...
class | CFrame
| The CFrame is the parent container of all views. More...
class | CGradient
| Gradient Object [new in 4.0]. More...
class | CGradientView
| View which draws a gradient. More...
class | CGraphicsPath
| Graphics Path Object. More...
struct | CGraphicsTransform
| Graphics Transform Matrix. More...
class | CHorizontalSlider
| a horizontal slider control More...
class | CHorizontalSwitch
| a horizontal switch control More...
struct | CInvalidRectList
class | CKickButton
class | CKnob
| a knob control More...
class | CKnobBase
class | CLayeredViewContainer
| a view container which draws into a platform layer on top of a parent layer or the platform viewA CLayeredViewContainer creates a platform layer on top of a parent layer or the platform view of CFrame if available on that platform and draws into it, otherwise it acts exactly like a CViewContainer More...
class | CLineStyle
class | CListControl
| Control which draws a list of configurable rows. More...
struct | CListControlRowDesc
| The description of one row for the CListControl. More...
class | CMemoryStream
| Memory input and output stream. More...
class | CMenuItem
| a menu item More...
class | CMouseWheelEditingSupport
| Helper class for mouse wheel editing. More...
class | CMovieBitmap
| a bitmap view that displays different bitmaps according to its current value More...
class | CMovieButton
| a bi-states button with 2 subbitmaps More...
class | CMultiFrameBitmap
| Multi frame bitmap. More...
struct | CMultiFrameBitmapDescription
| Description for a multi frame bitmap. More...
class | CMultiLineTextLabel
| Multi line text label. More...
class | CNewFileSelector
| New file selector class. More...
class | CNinePartTiledBitmap
| a nine-part tiled bitmap More...
struct | CNinePartTiledDescription
class | COffscreenContext
| A draw context using a bitmap as it's back buffer. More...
class | CommandMenuItemTargetAdapter
class | CompressedUIDescription
struct | ConcatClip
class | COnOffButton
| a button control with 2 states More...
class | COpenGLView
| a subview which uses OpenGL for drawing More...
class | COptionMenu
| a popup menu control More...
class | CParamDisplay
| a parameter display More...
struct | CPoint
| Point structure. More...
struct | CRect
| Rect structure. More...
class | CResourceDescription
| Describes a resource by name or by ID. More...
class | CResourceInputStream
| Resource input stream. More...
class | CRockerSwitch
| a switch control with 3 sub bitmaps More...
class | CRowColumnView
| a view container which layouts its subview as rows or columns More...
class | CScrollbar
| a scrollbar control More...
class | CScrollView
| a scrollable container view with scrollbars More...
class | CSearchTextEdit
| Search text edit field. More...
class | CSegmentButton
| Control which draws a segmented button. More...
class | CShadowViewContainer
| a view container which draws a shadow for it's subviews More...
class | CSlider
| a slider control More...
class | CSliderBase
class | CSpecialDigit
| special display with custom numbers (0...9) More...
class | CSplashScreen
class | CSplitView
| a split container view with separators between its child views More...
class | CSwitchBase
class | CTabView
| a tab view More...
class | CTextButton
| a button which renders without bitmaps More...
class | CTextEdit
| a text edit control More...
class | CTextLabel
| a text label More...
class | CTooltipSupport
| Generic Tooltip Support class. More...
class | CVerticalSlider
| a vertical slider control More...
class | CVerticalSwitch
| a vertical switch control More...
class | CView
| Base Class of all view objects. More...
class | CViewContainer
| Container Class of CView objects. More...
struct | CViewContainerDropTarget
class | CVSTGUITimer
| A timer class, which posts timer messages to CBaseObjects or calls a lambda function (c++11 only). More...
class | CVuMeter
class | CXYPad
class | DataBrowserDelegateAdapter
struct | DataPackageIterator
| IDataPackage iterator. More...
class | DelegationController
class | DispatchList
class | DragCallbackAdapter
| Drag callback interface adapter. More...
class | DragCallbackFunctions
| Drag callback interface adapter which calls std::functions. More...
struct | DragDescription
| Drag description. More...
struct | DragEventData
| Drag event data. More...
struct | DragStartMouseObserver
| Helper object to be used to decide if a mouse move is far enough to start a drag operation. More...
class | DropTargetAdapter
| Drop target interface adapter. More...
struct | ERect
struct | Event
| Event. More...
struct | EventConsumeState
| EventConsumeState. More...
class | FinalAction
struct | FocusDrawingSettings
class | GenericStringListDataBrowserSource
| Generic string list data browser source. More...
class | GenericStringListDataBrowserSourceSelectionChanged
struct | GestureEvent
| GestureEvent. More...
struct | GetViewOptions
struct | GlobalFonts
class | GroupController
class | IBitmapCreator
class | IBitmapCreator2
class | IColorChooserDelegate
class | ICommandMenuItemTarget
| Command menu item target. More...
class | IContentProvider
class | IContextMenuController
| extension to IController The VST3Editor checks all controllers of the views under the mouse on a right click if they have this interface implemented and calls the appendContextMenuItems before showing the context menu to the user More...
class | IContextMenuController2
class | IController
| extension to IControlListener used by UIDescription More...
class | IControlListener
class | IDataBrowserDelegate
| DataBrowser Interface. More...
class | IDataPackage
| interface for drag&drop and clipboard data More...
class | IDependency
| simple dependency between objects. More...
class | IDragCallback
| Drag callback interface. More...
class | IDraggingSession
| Dragging session interface. More...
class | IDropTarget
| Drop target interface. More...
class | IFocusDrawing
| Custom focus drawing interface. More...
class | IFocusViewObserver
| focus view observer interface for CFrame More...
class | IFontChooserDelegate
class | IKeyboardHook
| generic keyboard hook interface for CFrame More...
class | IListControlConfigurator
| The list control configurator interface. More...
class | IListControlDrawer
| The list control drawer interface. More...
class | IMouseObserver
| generic mouse observer interface for CFrame More...
class | IMultiBitmapControl
| interface for controls with sub images More...
class | InputStream
| ByteOrder aware input stream interface. More...
class | InputStreamContentProvider
class | Interface
class | IOptionMenuListener
| Option menu listener. More...
class | IReference
class | IScaleFactorChangedListener
class | IScrollbarDrawer
class | ISplitViewController
| Split View Controller. More...
class | ISplitViewSeparatorDrawer
| TODO: Doc. More...
class | ITextEditListener
| Listener for a text edit. More...
class | ITextLabelListener
| Listener for a text label. More...
class | IUIDescription
class | IViewAddedRemovedObserver
| view added removed observer interface for CFrame More...
class | IViewContainerListener
| ViewContainer Listener Interface. More...
class | IViewCreator
| View creator interface. More...
class | IViewEventListener
| View Event Listener Interface. More...
class | IViewFactory
class | IViewListener
| View Listener Interface. More...
class | IViewMouseListener
| View Mouse Listener Interface. More...
class | IViewSwitchController
class | IVST3EditorDelegate
| delegate interface for a VST3Editor. More...
struct | KeyboardEvent
| KeyboardEvent. More...
struct | ListenerProvider
struct | MallocAllocator
class | MemoryContentProvider
struct | ModalViewSession
struct | ModifierEvent
| ModifierEvent. More...
struct | Modifiers
| Modifiers. More...
struct | MouseCancelEvent
| MouseCancelEvent. More...
struct | MouseDownEvent
| MouseDownEvent. More...
struct | MouseDownUpMoveEvent
| MouseDownUpMoveEvent. More...
struct | MouseEnterEvent
| MouseEnterEvent. More...
struct | MouseEvent
| MouseEvent. More...
struct | MouseEventButtonState
| MouseEventButtonState. More...
struct | MouseExitEvent
| MouseExitEvent. More...
struct | MouseMoveEvent
| MouseMoveEvent. More...
struct | MousePositionEvent
| MousePositionEvent. More...
struct | MouseUpEvent
| MouseUpEvent. More...
struct | MouseWheelEvent
| MouseWheelEvent. More...
class | MultiFrameBitmapView
| an injection class for views that draw frames of a CMultiFrameBitmap More...
class | OldKeyboardHookAdapter
class | OldMouseObserverAdapter
struct | Optional
| simplified optional More...
class | OptionMenuListenerAdapter
class | OutputStream
| ByteOrder aware output stream interface. More...
class | OwningPointer
| An owning pointer. More...
class | PadController
class | ParameterChangeListener
class | PluginGUIEditor
class | ReferenceCounted
class | SeekableStream
| Seekable stream interface. More...
class | SharedPointer
class | StaticListControlConfigurator
| A list control configurator implementation. More...
class | StdOutStream
class | StringListControlDrawer
| A specialized list control drawer to draw strings. More...
class | TextEditListenerAdapter
class | TextLabelListenerAdapter
struct | TrimOptions
class | UIAttributes
class | UIDescription
| XML description parser and view creator. More...
class | UIDescriptionListener
class | UIDescriptionListenerAdapter
struct | UIDescriptionListenerOff
class | UIDescriptionViewSwitchController
class | UIViewFactory
| Default view factory. More...
class | UIViewSwitchContainer
class | UTF8CharacterIterator
class | UTF8CodePointIterator
class | UTF8String
| holds an UTF8 encoded string and a platform representation of it More...
class | UTF8StringView
| a view on a null terminated UTF-8 String More...
class | ViewContainerListenerAdapter
| ViewContainer Listener Interface Adapter. More...
class | ViewCreatorAdapter
| View creator interface adapter. More...
class | ViewCreatorRegistry
class | ViewEventListenerAdapter
| View Event Listener Interface Adapter. More...
class | ViewListenerAdapter
| View Listener Interface Adapter. More...
class | ViewMouseListenerAdapter
| View Mouse Listener Interface Adapter. More...
class | VST3Editor
| VST3 Editor with automatic parameter binding. More...
class | VST3EditorDelegate
| Default adapter implementation for IVST3EditorDelegate. More...
class | VSTGUIEditorInterface
class | ZLibInputContentProvider
class | ZLibInputStream
class | ZLibOutputStream
struct | ZoomGestureEvent
| ZoomGestureEvent. More...

## Typedefs
using | CMenuItemList = std::vector< SharedPointer< CMenuItem > >
using | CMenuItemIterator = CMenuItemList::iterator
using | CConstMenuItemIterator = CMenuItemList::const_iterator
using | CParamDisplayValueToStringProc = bool(*)(float value, char utf8String[256], void *userData)
using | CTextEditStringToValueProc = bool(*)(UTF8StringPtr txt, float &result, void *userData)
using | ViewIterator = CViewContainer::Iterator< false >
using | ReverseViewIterator = CViewContainer::Iterator< true >
using | CCoord = double
| coordinate type More...
using | IdStringPtr = const char *
| ID String pointer. More...
using | UTF8StringPtr = const char *
| UTF8 String pointer. More...
using | UTF8StringBuffer = char *
| UTF8 String buffer pointer. More...
using | AtomicReferenceCounted = ReferenceCounted< std::atomic< int32_t > >
using | NonAtomicReferenceCounted = ReferenceCounted< int32_t >
using | AssertionHandler = void(*)(const char *filename, const char *line, const char *condition, const char *desc)
using | CViewAttributeID = size_t
using | ModalViewSessionID = uint32_t
using | GradientColorStop = std::pair< double, CColor >
using | GradientColorStopMap = std::multimap< double, CColor >
using | LinePair = std::pair< CPoint, CPoint >
using | LineList = std::vector< LinePair >
using | PointList = std::vector< CPoint >
using | CFontRef = CFontDesc *
using | PlatformFramePtr = SharedPointer< IPlatformFrame >
using | PlatformBitmapPtr = SharedPointer< IPlatformBitmap >
using | PlatformFontPtr = SharedPointer< IPlatformFont >
using | PlatformStringPtr = SharedPointer< IPlatformString >
using | PlatformTimerPtr = SharedPointer< IPlatformTimer >
using | PlatformResourceInputStreamPtr = std::unique_ptr< IPlatformResourceInputStream >
using | PlatformFactoryPtr = std::unique_ptr< IPlatformFactory >
using | PlatformGradientPtr = std::unique_ptr< IPlatformGradient >
using | PlatformGraphicsPathPtr = std::unique_ptr< IPlatformGraphicsPath >
using | PlatformGraphicsPathFactoryPtr = std::shared_ptr< IPlatformGraphicsPathFactory >
using | PlatformFileSelectorPtr = std::shared_ptr< IPlatformFileSelector >
using | PlatformGraphicsDevicePtr = std::shared_ptr< IPlatformGraphicsDevice >
using | PlatformGraphicsDeviceContextPtr = std::shared_ptr< IPlatformGraphicsDeviceContext >
using | UIAttributesMap = std::unordered_map< std::string, std::string >
using | ViewCreatorRegistryMap = std::unordered_map< std::string, const IViewCreator * >
using | InterfacePtr = std::shared_ptr< Interface >

## Enumerations
enum | CButton { kLButton = 1 << 1 , kMButton = 1 << 2 , kRButton = 1 << 3 , kShift = 1 << 4 , kControl = 1 << 5 , kAlt = 1 << 6 , kApple = 1 << 7 , kButton4 = 1 << 8 , kButton5 = 1 << 9 , kDoubleClick = 1 << 10 , kMouseWheelInverted = 1 << 11 }
enum | CDrawModeFlags : uint32_t { kAliasing = 0 , kAntiAliasing = 1 , kNonIntegralMode = 0xF0000000 }
enum | CHoriTxtAlign { kLeftText = 0 , kCenterText , kRightText }
enum | CDrawStyle { kDrawStroked = 0 , kDrawFilled , kDrawFilledAndStroked }
enum | CKnobMode { kCircularMode = 0 , kRelativCircularMode , kLinearMode }
enum class | DragOperation { Copy , Move , None }
| Drag operation. More...
enum class | EventType : uint32_t { Unknown , MouseDown , MouseMove , MouseUp , MouseCancel , MouseEnter , MouseExit , MouseWheel , ZoomGesture , KeyUp , KeyDown }
| EventType. More...
enum class | MouseButton : uint32_t { None = 0 , Left = 1 << 1 , Middle = 1 << 2 , Right = 1 << 3 , Fourth = 1 << 4 , Fifth = 1 << 5 }
| MouseButton. More...
enum class | VirtualKey : uint32_t { None = 0 , Back , Tab , Clear , Return , Pause , Escape , Space , Next , End , Home , Left , Up , Right , Down , PageUp , PageDown , Select , Print , Enter , Snapshot , Insert , Delete , Help , NumPad0 , NumPad1 , NumPad2 , NumPad3 , NumPad4 , NumPad5 , NumPad6 , NumPad7 , NumPad8 , NumPad9 , Multiply , Add , Separator , Subtract , Decimal , Divide , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 , F10 , F11 , F12 , NumLock , Scroll , ShiftModifier , ControlModifier , AltModifier , Equals }
| VirtualKey. More...
enum class | ModifierKey : uint32_t { Shift = 1 << 0 , Alt = 1 << 1 , Control = 1 << 2 , Super = 1 << 3 , None = 0 }
| ModifierKey. More...
enum | ByteOrder { kBigEndianByteOrder = 0 , kLittleEndianByteOrder , kNativeByteOrder = kBigEndianByteOrder }
enum | CMessageResult { kMessageUnknown = 0 , kMessageNotified = 1 }
enum | CMouseWheelAxis { kMouseWheelAxisX = 0 , kMouseWheelAxisY }
enum | CMouseEventResult { kMouseEventNotImplemented = 0 , kMouseEventHandled , kMouseEventNotHandled , kMouseDownEventHandledButDontNeedMovedOrUpEvents , kMouseMoveEventHandledButDontNeedMoreEvents }
enum | CCursorType { kCursorDefault = 0 , kCursorWait , kCursorHSize , kCursorVSize , kCursorSizeAll , kCursorNESWSize , kCursorNWSESize , kCursorCopy , kCursorNotAllowed , kCursorHand , kCursorIBeam , kCursorCrosshair }
enum | CViewAutosizing { kAutosizeNone = 0 , kAutosizeLeft = 1 << 0 , kAutosizeTop = 1 << 1 , kAutosizeRight = 1 << 2 , kAutosizeBottom = 1 << 3 , kAutosizeColumn = 1 << 4 , kAutosizeRow = 1 << 5 , kAutosizeAll = kAutosizeLeft | kAutosizeTop | kAutosizeRight | kAutosizeBottom }
enum | DragResult { kDragRefused = 0 , kDragMoved , kDragCopied , kDragError = -1 }
enum | CTxtFace { kNormalFace = 0 , kBoldFace = 1 << 1 , kItalicFace = 1 << 2 , kUnderlineFace = 1 << 3 , kStrikethroughFace = 1 << 4 }
enum class | BitmapInterpolationQuality { kDefault = 0 , kLow , kMedium , kHigh }
enum class | CSliderMode { Touch , RelativeTouch , FreeClick , Ramp , UseGlobal }
enum class | SeekMode { Set , Current , End }

## Functions
template<typename Iter , typename Type , typename ResultType = int32_t>
Optional< ResultType > | indexOf (Iter first, Iter last, const Type &value)
| Returns the index of the value. More...
template<typename Iter , typename Proc , typename ResultType = int32_t>
Optional< ResultType > | indexOfTest (Iter first, Iter last, Proc p)
| Returns the index of the element for which predicate p returns true. More...
template<typename T >
T | clamp (T value, T min, T max)
| Returns the value clamped to min and max. More...
template<typename T >
T | clampNorm (T value)
| Returns the value clamped to zero and one. More...
template<typename NormT , typename StepT = int32_t>
StepT | normalizedToSteps (NormT value, StepT numSteps, StepT stepStart=static_cast< StepT >(0))
| Returns the value projected lineary between stepOffset and stepOffset + steps. More...
template<typename NormT , typename StepValueT , typename StepT >
NormT | stepsToNormalized (StepValueT value, StepT steps, StepT stepOffset=static_cast< StepT >(0))
| Returns the normalized value from the step value. More...
template<typename NormT , typename PlainT >
NormT | plainToNormalized (PlainT value, PlainT minValue, PlainT maxValue)
| Returns the normalized value from a plain one. More...
template<typename PlainT , typename NormT >
PlainT | normalizedToPlain (NormT value, PlainT minValue, PlainT maxValue)
| Returns the plain value from a normalized one. More...
template<typename T1 , typename T2 , typename std::enable_if< std::is_same< PixelBuffer::Format, T2 >::value||std::is_same< IPlatformBitmapPixelAccess::PixelFormat, T2 >::value >::type * = nullptr>
T1 | convert (T2 format)
| Convert between Platform Pixel Accessor pixel format and PixelBuffer format. More...
constexpr CColor | MakeCColor (uint8_t red=0, uint8_t green=0, uint8_t blue=0, uint8_t alpha=255)
static PlatformGraphicsDrawStyle | convert (CDrawStyle s)
static PlatformGraphicsPathDrawMode | convert (CDrawContext::PathDrawMode mode)
template<typename Proc >
void | drawClipped (CDrawContext *context, const CRect &clip, Proc proc)
static double | radians (double degrees)
void | joinNearbyInvalidRects (CInvalidRectList &list, CCoord maxDistance)
SharedPointer< CBitmap > | renderBitmapOffscreen (const CPoint &size, double scaleFactor, const std::function< void(CDrawContext &drawContext)> drawFunction)
| Render a bitmap offscreen. More...
bool | isLineBreakSeparator (char32_t c)
template<size_t numBoxes>
static std::array< int32_t, numBoxes > | boxesForGauss (double sigma)
static bool | isUniformScaled (const CGraphicsTransform &matrix)
static ISplitViewController * | getSplitViewController (const CView *view)
bool | isSpace (char32_t character) noexcept
| white-character test More...
UTF8String | trim (const UTF8String &str, TrimOptions options)
bool | operator== (const UTF8String::StringType &lhs, const UTF8String &rhs) noexcept
bool | operator!= (const UTF8String::StringType &lhs, const UTF8String &rhs) noexcept
UTF8String | operator+ (UTF8StringPtr lhs, const UTF8String &rhs)
template<typename T >
UTF8String | toString (const T &value)
static Buffer< char > | getTooltipFromView (CView *view)
static bool | viewHasTooltip (CView *view)
bool | shouldStartDrag (CPoint mouseDownPos, CPoint mouseMovePos)
| Helper method to be used to decide if a mouse move is far enough to start a drag operation. More...
CButtonState | buttonStateFromEventModifiers (const Modifiers &mods)
| convert from new Modifiers to old CButtonState More...
CButtonState | buttonStateFromMouseEvent (const MouseEvent &event)
| convert from new MouseEvent to old CButtonState More...
VstKeyCode | toVstKeyCode (const KeyboardEvent &event)
const Event & | noEvent ()
template<typename EventT , typename OutputT = MousePositionEvent, typename MousePositionEventT = typename std::conditional< std::is_const_v<EventT>, typename std::add_const_t<OutputT>, OutputT>::type>
MousePositionEventT * | asMousePositionEvent (EventT &event)
| event as mouse position event or nullpointer if not a mouse position event More...
template<typename EventT , typename OutputT = MouseEvent, typename MouseEventT = typename std::conditional< std::is_const_v<EventT>, typename std::add_const_t<OutputT>, OutputT>::type>
MouseEventT * | asMouseEvent (EventT &event)
| event as mouse position event or nullpointer if not a mouse position event More...
template<typename EventT , typename OutputT = MouseDownEvent, typename MouseDownEventT = typename std::conditional< std::is_const_v<EventT>, typename std::add_const_t<OutputT>, OutputT>::type>
MouseDownEventT * | asMouseDownEvent (EventT &event)
| event as mouse down event or nullpointer if not a mouse down event More...
template<typename EventT , typename OutputT = ModifierEvent, typename ModifierEventT = typename std::conditional< std::is_const_v<EventT>, typename std::add_const_t<OutputT>, OutputT>::type>
ModifierEventT * | asModifierEvent (EventT &event)
| event as modifier event or nullpointer if not a modifier event More...
template<typename EventT , typename OutputT = KeyboardEvent, typename KeyboardEventT = typename std::conditional< std::is_const_v<EventT>, typename std::add_const_t<OutputT>, OutputT>::type>
KeyboardEventT * | asKeyboardEvent (EventT &event)
| event as keyboard event or nullpointer if not a keyboard event More...
MousePositionEvent & | castMousePositionEvent (Event &event)
| cast event to a mouse position event More...
MouseEvent & | castMouseEvent (Event &event)
| cast event to a mouse event More...
MouseDownEvent & | castMouseDownEvent (Event &event)
| cast event to a mouse down event More...
MouseMoveEvent & | castMouseMoveEvent (Event &event)
| cast event to a mouse move event More...
MouseUpEvent & | castMouseUpEvent (Event &event)
| cast event to a mouse up event More...
MouseEnterEvent & | castMouseEnterEvent (Event &event)
| cast event to a mouse enter event More...
MouseExitEvent & | castMouseExitEvent (Event &event)
| cast event to a mouse exit event More...
MouseCancelEvent & | castMouseCancelEvent (Event &event)
| cast event to a mouse cancel event More...
MouseWheelEvent & | castMouseWheelEvent (Event &event)
| cast event to a mouse wheel event More...
ZoomGestureEvent & | castZoomGestureEvent (Event &event)
| cast event to a zoom gesture event More...
KeyboardEvent & | castKeyboardEvent (Event &event)
| cast event to a mouse wheel event More...
unsigned char | toVstVirtualKey (VirtualKey key)
| helper function to convert from new VirtualKey to old VstVirtualKey More...
VirtualKey | fromVstVirtualKey (uint32_t key)
template<class F >
auto | finally (F &&f) noexcept
DataPackageIterator | begin (IDataPackage *pkg)
DataPackageIterator | end (IDataPackage *pkg)
template<typename T >
Optional< typename std::decay< T >::type > | makeOptional (T &&value)
template<class I >
SharedPointer< I > | owned (I *p) noexcept
template<class I >
SharedPointer< I > | shared (I *p) noexcept
template<class I , typename ... Args>
SharedPointer< I > | makeOwned (Args &&...args)
template<typename T , typename B >
void | setBit (T &storage, B bit, bool state)
template<typename T , typename B >
constexpr bool | hasBit (T storage, B bit)
void | setAssertionHandler (AssertionHandler handler)
bool | hasAssertionHandler ()
void | doAssert (const char *filename, const char *line, const char *condition, const char *desc) noexcept(false)
void | init (PlatformInstanceHandle instance)
| Init to use VSTGUI. More...
void | exit ()
| exit using the VSTGUI library. More...
template<typename T >
void | endianSwap (T &value)
template<typename T >
bool | writeEndianSwap (const T &value, OutputStream &s)
void | unixfyPath (std::string &path)
| Helper function to transform all Windows path separators to unix ones. More...
bool | removeLastPathComponent (std::string &path)
Optional< std::string > | lastPathComponent (const std::string path)
bool | pathIsAbsolute (const std::string &path)
IController * | getViewController (const CView *view, bool deep=false)
| helper method to get the controller of a view More...
template<typename T >
T * | findViewController (const CViewContainer *view)
| helper method to find a specific controller inside a view hierarchy More...
static UIViewFactory * | getGenericViewFactory ()
static void | FreeNodePlatformResources (Detail::UINode *node)
static std::string | moveOldFile (UTF8StringPtr filename)
static void | removeChildNode (Detail::UINode *baseNode, UTF8StringPtr nodeName)
static ViewCreatorRegistry & | getCreatorRegistry ()
static CControl * | findControlForTag (CViewContainer *parent, int32_t tag, bool reverse=true)
template<typename Iface , typename T >
auto | dynamicPtrCast (std::shared_ptr< T > &obj)
template<typename Iface , typename T >
const auto | dynamicPtrCast (const std::shared_ptr< T > &obj)
template<typename Iface , typename T >
auto | staticPtrCast (std::shared_ptr< T > &obj)
template<typename Iface , typename T >
const auto | staticPtrCast (const std::shared_ptr< T > &obj)
template<typename Iface , typename T >
const auto & | asInterface (const T &obj)

## Variables
constexpr const CColor | kTransparentCColor = CColor (255, 255, 255, 0)
constexpr const CColor | kBlackCColor = CColor ( 0, 0, 0, 255)
constexpr const CColor | kWhiteCColor = CColor (255, 255, 255, 255)
constexpr const CColor | kGreyCColor = CColor (127, 127, 127, 255)
constexpr const CColor | kRedCColor = CColor (255, 0, 0, 255)
constexpr const CColor | kGreenCColor = CColor ( 0, 255, 0, 255)
constexpr const CColor | kBlueCColor = CColor ( 0, 0, 255, 255)
constexpr const CColor | kYellowCColor = CColor (255, 255, 0, 255)
constexpr const CColor | kMagentaCColor = CColor (255, 0, 255, 255)
constexpr const CColor | kCyanCColor = CColor ( 0, 255, 255, 255)
static GlobalFonts | globalFonts
CFontRef | kSystemFont = nullptr
CFontRef | kNormalFontVeryBig = nullptr
CFontRef | kNormalFontBig = nullptr
CFontRef | kNormalFont = nullptr
CFontRef | kNormalFontSmall = nullptr
CFontRef | kNormalFontSmaller = nullptr
CFontRef | kNormalFontVerySmall = nullptr
CFontRef | kSymbolFont = nullptr
IdStringPtr | kMsgNewFocusView = "kMsgNewFocusView"
| Message send to all parents of the new focus view. More...
IdStringPtr | kMsgOldFocusView = "kMsgOldFocusView"
| Message send to all parents of the old focus view. More...
static const CCoord | kDefaultOnOffDashLength [] = {1, 1}
const CLineStyle | kLineSolid {}
const CLineStyle | kLineOnOffDash (CLineStyle::kLineCapButt, CLineStyle::kLineJoinMiter, 0, 2, kDefaultOnOffDashLength)
static CCoord | kCheckBoxTitleMargin = 5
static const float | kCKnobRangeDefault = 200.f
static constexpr CViewAttributeID | kCKnobMouseStateAttribute = 'knms'
UTF8StringPtr | kDegreeSymbol = "\xC2\xB0"
| degree sign More...
UTF8StringPtr | kInfiniteSymbol = "\xE2\x88\x9E"
| infinity sign More...
UTF8StringPtr | kCopyrightSymbol = "\xC2\xA9"
| copyright sign More...
UTF8StringPtr | kTrademarkSymbol = "\xE2\x84\xA2"
| trade mark sign More...
UTF8StringPtr | kRegisteredSymbol = "\xC2\xAE"
| registered sign More...
UTF8StringPtr | kMicroSymbol = "\xC2\xB5"
| micro sign More...
UTF8StringPtr | kPerthousandSymbol = "\xE2\x80\xB0"
| per mille sign More...
IdStringPtr | kMsgViewSizeChanged = "kMsgViewSizeChanged"
| Message send to parent that the size of the view has changed. More...
static constexpr CViewAttributeID | kCViewHitTestPathAttrID = 'cvht'
static constexpr CViewAttributeID | kCViewCustomDropTargetAttrID = 'cvdt'
static constexpr CViewAttributeID | kCViewAlphaValueAttrID = 'cvav'
static constexpr CViewAttributeID | kCViewMouseableAreaAttrID = 'cvma'
static constexpr CViewAttributeID | kCViewBackgroundBitmapAttrID = 'cvbb'
static constexpr CViewAttributeID | kCViewDisabledBackgroundBitmapAttrID = 'cvdb'
static constexpr CViewAttributeID | kCViewAttributeReferencePointer = 'cvrp'
static constexpr CViewAttributeID | kCViewTooltipAttribute = 'cvtt'
static constexpr CViewAttributeID | kCViewControllerAttribute = 'ictr'
IdStringPtr | kMsgLooseFocus = "LooseFocus"
| Message of a view loosing focus (only CTextEdit and COptionMenu send this) More...
const CViewAttributeID | kCViewContainerDropTargetAttribute = 'vcdt'
const CViewAttributeID | kCViewContainerMouseDownViewAttribute = 'vcmd'
const CViewAttributeID | kCViewContainerLastDrawnFocusAttribute = 'vclf'
const CViewAttributeID | kCViewContainerBackgroundOffsetAttribute = 'vcbo'
static AssertionHandler | assertionHandler = nullptr
static constexpr uint32_t | kStreamIOError = (std::numeric_limits<uint32_t>::max) ()
static constexpr int64_t | kStreamSeekError = -1
static constexpr int64_t | kUIDescIdentifier = 0x7072637365646975LL
static const int8_t | unixPathSeparator = '/'
static const int8_t | windowsPathSeparator = '\\'
static constexpr auto | kTemplateAttributeMinSize = "minSize"
static constexpr auto | kTemplateAttributeMaxSize = "maxSize"
static CViewAttributeID | kViewNameAttribute = 'cvcr'

## Typedef Documentation

## ◆ AssertionHandler

using AssertionHandler = void (*) (const char* filename, const char* line, const char* condition, const char* desc)

## ◆ AtomicReferenceCounted

using AtomicReferenceCounted = ReferenceCounted<std::atomic<int32_t> >

## ◆ CConstMenuItemIterator

using CConstMenuItemIterator = CMenuItemList::const_iterator

## ◆ CCoord

using CCoord = double

coordinate type

## ◆ CFontRef

using CFontRef = CFontDesc*

## ◆ CMenuItemIterator

using CMenuItemIterator = CMenuItemList::iterator

## ◆ CMenuItemList

using CMenuItemList = std::vector<SharedPointer<CMenuItem> >

## ◆ CParamDisplayValueToStringProc

using CParamDisplayValueToStringProc = bool (*) (float value, char utf8String[256], void* userData)

## ◆ CTextEditStringToValueProc

using CTextEditStringToValueProc = bool (*) (UTF8StringPtr txt, float& result, void* userData)

## ◆ CViewAttributeID

using CViewAttributeID = size_t

## ◆ GradientColorStop

using GradientColorStop = std::pair<double, CColor>

## ◆ GradientColorStopMap

using GradientColorStopMap = std::multimap<double, CColor>

## ◆ IdStringPtr

using IdStringPtr = const char*

ID String pointer.

## ◆ InterfacePtr

using InterfacePtr = std::shared_ptr<Interface>

## ◆ LineList

using LineList = std::vector<LinePair>

## ◆ LinePair

using LinePair = std::pair<CPoint, CPoint>

## ◆ ModalViewSessionID

using ModalViewSessionID = uint32_t

## ◆ NonAtomicReferenceCounted

using NonAtomicReferenceCounted = ReferenceCounted<int32_t>

## ◆ PlatformBitmapPtr

using PlatformBitmapPtr = SharedPointer<IPlatformBitmap>

## ◆ PlatformFactoryPtr

using PlatformFactoryPtr = std::unique_ptr<IPlatformFactory>

## ◆ PlatformFileSelectorPtr

using PlatformFileSelectorPtr = std::shared_ptr<IPlatformFileSelector>

## ◆ PlatformFontPtr

using PlatformFontPtr = SharedPointer<IPlatformFont>

## ◆ PlatformFramePtr

using PlatformFramePtr = SharedPointer<IPlatformFrame>

## ◆ PlatformGradientPtr

using PlatformGradientPtr = std::unique_ptr<IPlatformGradient>

## ◆ PlatformGraphicsDeviceContextPtr

using PlatformGraphicsDeviceContextPtr = std::shared_ptr<IPlatformGraphicsDeviceContext>

## ◆ PlatformGraphicsDevicePtr

using PlatformGraphicsDevicePtr = std::shared_ptr<IPlatformGraphicsDevice>

## ◆ PlatformGraphicsPathFactoryPtr

using PlatformGraphicsPathFactoryPtr = std::shared_ptr<IPlatformGraphicsPathFactory>

## ◆ PlatformGraphicsPathPtr

using PlatformGraphicsPathPtr = std::unique_ptr<IPlatformGraphicsPath>

## ◆ PlatformResourceInputStreamPtr

using PlatformResourceInputStreamPtr = std::unique_ptr<IPlatformResourceInputStream>

## ◆ PlatformStringPtr

using PlatformStringPtr = SharedPointer<IPlatformString>

## ◆ PlatformTimerPtr

using PlatformTimerPtr = SharedPointer<IPlatformTimer>

## ◆ PointList

using PointList = std::vector<CPoint>

## ◆ ReverseViewIterator

using ReverseViewIterator = CViewContainer::Iterator<true>

## ◆ UIAttributesMap

using UIAttributesMap = std::unordered_map<std::string,std::string>

## ◆ UTF8StringBuffer

using UTF8StringBuffer = char*

UTF8 String buffer pointer.

## ◆ UTF8StringPtr

using UTF8StringPtr = const char*

UTF8 String pointer.

## ◆ ViewCreatorRegistryMap

using ViewCreatorRegistryMap = std::unordered_map<std::string, const IViewCreator*>

## ◆ ViewIterator

using ViewIterator = CViewContainer::Iterator<false>

## Enumeration Type Documentation

## ◆ BitmapInterpolationQuality

enum class BitmapInterpolationQuality
| strong

Enumerator
kDefault | Let system decide.
kLow | Nearest neighbour.
kMedium | Bilinear interpolation.
kHigh | Bicubic interpolation (Bilinear on Windows)

## ◆ ByteOrder

enum ByteOrder

Enumerator
kBigEndianByteOrder |
kLittleEndianByteOrder |
kNativeByteOrder |

## ◆ CButton

enum CButton

Enumerator
kLButton | left mouse button
kMButton | middle mouse button
kRButton | right mouse button
kShift | shift modifier
kControl | control modifier (Command Key on Mac OS X and Control Key on Windows)
kAlt | alt modifier
kApple | apple modifier (Mac OS X only. Is the Control key)
kButton4 | 4th mouse button
kButton5 | 5th mouse button
kDoubleClick | mouse button is double click
kMouseWheelInverted | system mouse wheel setting is inverted (Only valid for onMouseWheel methods). The distance value is already transformed back to non inverted. But for scroll views we need to know if we need to invert it back.

## ◆ CCursorType

enum CCursorType

Enumerator
kCursorDefault | arrow cursor
kCursorWait | wait cursor
kCursorHSize | horizontal size cursor
kCursorVSize | vertical size cursor
kCursorSizeAll | size all cursor
kCursorNESWSize | northeast and southwest size cursor
kCursorNWSESize | northwest and southeast size cursor
kCursorCopy | copy cursor (mainly for drag&drop operations)
kCursorNotAllowed | not allowed cursor (mainly for drag&drop operations)
kCursorHand | hand cursor
kCursorIBeam | i beam cursor
kCursorCrosshair | crosshair cursor

## ◆ CDrawModeFlags

enum CDrawModeFlags : uint32_t

Enumerator
kAliasing | aliased drawing
kAntiAliasing | antialised drawing
kNonIntegralMode | do not round coordinates to pixel aligned values

## ◆ CDrawStyle

enum CDrawStyle

Enumerator
kDrawStroked |
kDrawFilled |
kDrawFilledAndStroked |

## ◆ CHoriTxtAlign

enum CHoriTxtAlign

Enumerator
kLeftText |
kCenterText |
kRightText |

## ◆ CKnobMode

enum CKnobMode

Enumerator
kCircularMode |
kRelativCircularMode |
kLinearMode |

## ◆ CMessageResult

enum CMessageResult

Enumerator
kMessageUnknown |
kMessageNotified |

## ◆ CMouseEventResult

enum CMouseEventResult

Enumerator
kMouseEventNotImplemented |
kMouseEventHandled |
kMouseEventNotHandled |
kMouseDownEventHandledButDontNeedMovedOrUpEvents |
kMouseMoveEventHandledButDontNeedMoreEvents |

## ◆ CMouseWheelAxis

enum CMouseWheelAxis

Enumerator
kMouseWheelAxisX |
kMouseWheelAxisY |

## ◆ CSliderMode

enum class CSliderMode
| strong

Enumerator
Touch |
RelativeTouch |
FreeClick |
Ramp |
UseGlobal |

## ◆ CTxtFace

enum CTxtFace

Enumerator
kNormalFace |
kBoldFace |
kItalicFace |
kUnderlineFace |
kStrikethroughFace |

## ◆ CViewAutosizing

enum CViewAutosizing

Enumerator
kAutosizeNone |
kAutosizeLeft |
kAutosizeTop |
kAutosizeRight |
kAutosizeBottom |
kAutosizeColumn |
kAutosizeRow |
kAutosizeAll |

## ◆ DragResult

enum DragResult

Enumerator
kDragRefused |
kDragMoved |
kDragCopied |
kDragError |

## ◆ SeekMode

enum class SeekMode
| strong

Enumerator
Set |
Current |
End |

## Function Documentation

## ◆ asInterface()

const auto & VSTGUI::asInterface | ( | const T & | obj | ) |
| inline

## ◆ begin()

DataPackageIterator VSTGUI::begin | ( | IDataPackage * | pkg | ) |
| inline

## ◆ boxesForGauss()

static std::array< int32_t, numBoxes > VSTGUI::boxesForGauss | ( | double | sigma | ) |
| static

## ◆ clamp()

T VSTGUI::clamp | ( | T | value,
|  | T | min,
|  | T | max
| ) |  |

Returns the value clamped to min and max.

## ◆ clampNorm()

T VSTGUI::clampNorm | ( | T | value | ) |

Returns the value clamped to zero and one.

## ◆ convert() [1/3]

static PlatformGraphicsPathDrawMode VSTGUI::convert | ( | CDrawContext::PathDrawMode | mode | ) |
| static

## ◆ convert() [2/3]

static PlatformGraphicsDrawStyle VSTGUI::convert | ( | CDrawStyle | s | ) |
| static

## ◆ convert() [3/3]

T1 VSTGUI::convert | ( | T2 | format | ) |
| inline

Convert between Platform Pixel Accessor pixel format and PixelBuffer format.

## ◆ doAssert()

void doAssert | ( | const char * | filename,
|  | const char * | line,
|  | const char * | condition,
|  | const char * | desc
| ) |  |
| noexcept

## ◆ drawClipped()

void VSTGUI::drawClipped | ( | CDrawContext * | context,
|  | const CRect & | clip,
|  | Proc | proc
| ) |  |

## ◆ dynamicPtrCast() [1/2]

const auto VSTGUI::dynamicPtrCast | ( | const std::shared_ptr< T > & | obj | ) |
| inline

## ◆ dynamicPtrCast() [2/2]

auto VSTGUI::dynamicPtrCast | ( | std::shared_ptr< T > & | obj | ) |
| inline

## ◆ end()

DataPackageIterator VSTGUI::end | ( | IDataPackage * | pkg | ) |
| inline

## ◆ endianSwap()

void VSTGUI::endianSwap | ( | T & | value | ) |

## ◆ finally()

auto VSTGUI::finally | ( | F && | f | ) |
| noexcept

## ◆ findControlForTag()

static CControl * VSTGUI::findControlForTag | ( | CViewContainer * | parent,
|  | int32_t | tag,
|  | bool | reverse = `true`
| ) |  |
| static

## ◆ findViewController()

T * VSTGUI::findViewController | ( | const CViewContainer * | view | ) |
| inline

helper method to find a specific controller inside a view hierarchy

## ◆ FreeNodePlatformResources()

static void VSTGUI::FreeNodePlatformResources | ( | Detail::UINode * | node | ) |
| static

## ◆ fromVstVirtualKey()

VirtualKey VSTGUI::fromVstVirtualKey | ( | uint32_t | key | ) |
| inline

## ◆ getCreatorRegistry()

static ViewCreatorRegistry & VSTGUI::getCreatorRegistry | ( |  | ) |
| static

## ◆ getGenericViewFactory()

static UIViewFactory * VSTGUI::getGenericViewFactory | ( |  | ) |
| static

## ◆ getSplitViewController()

static ISplitViewController * VSTGUI::getSplitViewController | ( | const CView * | view | ) |
| static

## ◆ getTooltipFromView()

static Buffer< char > VSTGUI::getTooltipFromView | ( | CView * | view | ) |
| static

## ◆ getViewController()

IController * VSTGUI::getViewController | ( | const CView * | view,
|  | bool | deep = `false`
| ) |  |
| inline

helper method to get the controller of a view

## ◆ hasAssertionHandler()

bool hasAssertionHandler | ( |  | ) |

## ◆ hasBit()

constexpr bool VSTGUI::hasBit | ( | T | storage,
|  | B | bit
| ) |  |
| inlineconstexpr

## ◆ indexOf()

Optional< ResultType > VSTGUI::indexOf | ( | Iter | first,
|  | Iter | last,
|  | const Type & | value
| ) |  |

Returns the index of the value.

## ◆ indexOfTest()

Optional< ResultType > VSTGUI::indexOfTest | ( | Iter | first,
|  | Iter | last,
|  | Proc | p
| ) |  |

Returns the index of the element for which predicate p returns true.

## ◆ isLineBreakSeparator()

bool VSTGUI::isLineBreakSeparator | ( | char32_t | c | ) |
| inline

## ◆ isSpace()

bool isSpace | ( | char32_t | character | ) |
| noexcept

white-character test

Parameters

  character | UTF-32 character

Returns
  true if character is a white-character

## ◆ isUniformScaled()

static bool VSTGUI::isUniformScaled | ( | const CGraphicsTransform & | matrix | ) |
| static

## ◆ joinNearbyInvalidRects()

void VSTGUI::joinNearbyInvalidRects | ( | CInvalidRectList & | list,
|  | CCoord | maxDistance
| ) |  |
| inline

## ◆ lastPathComponent()

Optional< std::string > VSTGUI::lastPathComponent | ( | const std::string | path | ) |
| inline

## ◆ MakeCColor()

constexpr CColor VSTGUI::MakeCColor | ( | uint8_t | red = `0`,
|  | uint8_t | green = `0`,
|  | uint8_t | blue = `0`,
|  | uint8_t | alpha = `255`
| ) |  |
| inlineconstexpr

## ◆ makeOptional()

Optional< typename std::decay< T >::type > VSTGUI::makeOptional | ( | T && | value | ) |
| inline

## ◆ makeOwned()

SharedPointer< I > VSTGUI::makeOwned | ( | Args &&... | args | ) |
| inline

## ◆ moveOldFile()

static std::string VSTGUI::moveOldFile | ( | UTF8StringPtr | filename | ) |
| static

## ◆ noEvent()

const Event & noEvent | ( |  | ) |
| inline

## ◆ normalizedToPlain()

PlainT VSTGUI::normalizedToPlain | ( | NormT | value,
|  | PlainT | minValue,
|  | PlainT | maxValue
| ) |  |

Returns the plain value from a normalized one.

## ◆ normalizedToSteps()

StepT VSTGUI::normalizedToSteps | ( | NormT | value,
|  | StepT | numSteps,
|  | StepT | stepStart = `static_cast<StepT> (0)`
| ) |  |

Returns the value projected lineary between stepOffset and stepOffset + steps.

## ◆ operator!=()

bool VSTGUI::operator!= | ( | const UTF8String::StringType & | lhs,
|  | const UTF8String & | rhs
| ) |  |
| inlinenoexcept

## ◆ operator+()

UTF8String VSTGUI::operator+ | ( | UTF8StringPtr | lhs,
|  | const UTF8String & | rhs
| ) |  |
| inline

## ◆ operator==()

bool VSTGUI::operator== | ( | const UTF8String::StringType & | lhs,
|  | const UTF8String & | rhs
| ) |  |
| inlinenoexcept

## ◆ owned()

SharedPointer< I > VSTGUI::owned | ( | I * | p | ) |
| inlinenoexcept

## ◆ pathIsAbsolute()

bool VSTGUI::pathIsAbsolute | ( | const std::string & | path | ) |
| inline

## ◆ plainToNormalized()

NormT VSTGUI::plainToNormalized | ( | PlainT | value,
|  | PlainT | minValue,
|  | PlainT | maxValue
| ) |  |

Returns the normalized value from a plain one.

## ◆ radians()

static double VSTGUI::radians | ( | double | degrees | ) |
| inlinestatic

## ◆ removeChildNode()

static void VSTGUI::removeChildNode | ( | Detail::UINode * | baseNode,
|  | UTF8StringPtr | nodeName
| ) |  |
| static

## ◆ removeLastPathComponent()

bool VSTGUI::removeLastPathComponent | ( | std::string & | path | ) |
| inline

## ◆ renderBitmapOffscreen()

SharedPointer< CBitmap > renderBitmapOffscreen | ( | const CPoint & | size,
|  | double | scaleFactor,
|  | const std::function< void(CDrawContext &drawContext)> | drawFunction
| ) |  |

Render a bitmap offscreen.

Parameters

  size | size of the bitmap
  scaleFactor | scale factor (bitmap size will be scaled by this)
  drawFunction | user supplied draw function

Returns
  bitmap pointer on success and nullptr on failure

## ◆ setAssertionHandler()

void setAssertionHandler | ( | AssertionHandler | handler | ) |

## ◆ setBit()

void VSTGUI::setBit | ( | T & | storage,
|  | B | bit,
|  | bool | state
| ) |  |
| inline

## ◆ shared()

SharedPointer< I > VSTGUI::shared | ( | I * | p | ) |
| inlinenoexcept

## ◆ staticPtrCast() [1/2]

const auto VSTGUI::staticPtrCast | ( | const std::shared_ptr< T > & | obj | ) |
| inline

## ◆ staticPtrCast() [2/2]

auto VSTGUI::staticPtrCast | ( | std::shared_ptr< T > & | obj | ) |
| inline

## ◆ stepsToNormalized()

NormT VSTGUI::stepsToNormalized | ( | StepValueT | value,
|  | StepT | steps,
|  | StepT | stepOffset = `static_cast<StepT> (0)`
| ) |  |

Returns the normalized value from the step value.

## ◆ toString()

UTF8String VSTGUI::toString | ( | const T & | value | ) |
| inline

## ◆ toVstKeyCode()

VstKeyCode toVstKeyCode | ( | const KeyboardEvent & | event | ) |

## ◆ trim()

UTF8String trim | ( | const UTF8String & | str,
|  | TrimOptions | options
| ) |  |

## ◆ unixfyPath()

void VSTGUI::unixfyPath | ( | std::string & | path | ) |
| inline

Helper function to transform all Windows path separators to unix ones.

## ◆ viewHasTooltip()

static bool VSTGUI::viewHasTooltip | ( | CView * | view | ) |
| static

## ◆ writeEndianSwap()

bool VSTGUI::writeEndianSwap | ( | const T & | value,
|  | OutputStream & | s
| ) |  |

## Variable Documentation

## ◆ assertionHandler

AssertionHandler assertionHandler = nullptr
| static

## ◆ globalFonts

GlobalFonts globalFonts
| static

## ◆ kBlackCColor

constexpr const CColor kBlackCColor = CColor ( 0, 0, 0, 255)
| constexpr

## ◆ kBlueCColor

constexpr const CColor kBlueCColor = CColor ( 0, 0, 255, 255)
| constexpr

## ◆ kCheckBoxTitleMargin

CCoord kCheckBoxTitleMargin = 5
| static

## ◆ kCKnobMouseStateAttribute

constexpr CViewAttributeID kCKnobMouseStateAttribute = 'knms'
| staticconstexpr

## ◆ kCKnobRangeDefault

const float kCKnobRangeDefault = 200.f
| static

## ◆ kCopyrightSymbol

UTF8StringPtr kCopyrightSymbol = "\xC2\xA9"

copyright sign

## ◆ kCViewAlphaValueAttrID

constexpr CViewAttributeID kCViewAlphaValueAttrID = 'cvav'
| staticconstexpr

## ◆ kCViewAttributeReferencePointer

constexpr CViewAttributeID kCViewAttributeReferencePointer = 'cvrp'
| staticconstexpr

## ◆ kCViewBackgroundBitmapAttrID

constexpr CViewAttributeID kCViewBackgroundBitmapAttrID = 'cvbb'
| staticconstexpr

## ◆ kCViewContainerBackgroundOffsetAttribute

const CViewAttributeID kCViewContainerBackgroundOffsetAttribute = 'vcbo'

## ◆ kCViewContainerDropTargetAttribute

const CViewAttributeID kCViewContainerDropTargetAttribute = 'vcdt'

## ◆ kCViewContainerLastDrawnFocusAttribute

const CViewAttributeID kCViewContainerLastDrawnFocusAttribute = 'vclf'

## ◆ kCViewContainerMouseDownViewAttribute

const CViewAttributeID kCViewContainerMouseDownViewAttribute = 'vcmd'

## ◆ kCViewControllerAttribute

constexpr CViewAttributeID kCViewControllerAttribute = 'ictr'
| staticconstexpr

## ◆ kCViewCustomDropTargetAttrID

constexpr CViewAttributeID kCViewCustomDropTargetAttrID = 'cvdt'
| staticconstexpr

## ◆ kCViewDisabledBackgroundBitmapAttrID

constexpr CViewAttributeID kCViewDisabledBackgroundBitmapAttrID = 'cvdb'
| staticconstexpr

## ◆ kCViewHitTestPathAttrID

constexpr CViewAttributeID kCViewHitTestPathAttrID = 'cvht'
| staticconstexpr

## ◆ kCViewMouseableAreaAttrID

constexpr CViewAttributeID kCViewMouseableAreaAttrID = 'cvma'
| staticconstexpr

## ◆ kCViewTooltipAttribute

constexpr CViewAttributeID kCViewTooltipAttribute = 'cvtt'
| staticconstexpr

## ◆ kCyanCColor

constexpr const CColor kCyanCColor = CColor ( 0, 255, 255, 255)
| constexpr

## ◆ kDefaultOnOffDashLength

const CCoord kDefaultOnOffDashLength[] = {1, 1}
| static

## ◆ kDegreeSymbol

UTF8StringPtr kDegreeSymbol = "\xC2\xB0"

degree sign

## ◆ kGreenCColor

constexpr const CColor kGreenCColor = CColor ( 0, 255, 0, 255)
| constexpr

## ◆ kGreyCColor

constexpr const CColor kGreyCColor = CColor (127, 127, 127, 255)
| constexpr

## ◆ kInfiniteSymbol

UTF8StringPtr kInfiniteSymbol = "\xE2\x88\x9E"

infinity sign

## ◆ kLineOnOffDash

const CLineStyle kLineOnOffDash | ( | CLineStyle::kLineCapButt | ,
|  | CLineStyle::kLineJoinMiter | ,
|  | 0 | ,
|  | 2 | ,
|  | kDefaultOnOffDashLength |
| ) |  |

## ◆ kLineSolid

const CLineStyle kLineSolid {}

## ◆ kMagentaCColor

constexpr const CColor kMagentaCColor = CColor (255, 0, 255, 255)
| constexpr

## ◆ kMicroSymbol

UTF8StringPtr kMicroSymbol = "\xC2\xB5"

micro sign

## ◆ kMsgLooseFocus

IdStringPtr kMsgLooseFocus = "LooseFocus"

Message of a view loosing focus (only CTextEdit and COptionMenu send this)

## ◆ kMsgNewFocusView

IdStringPtr kMsgNewFocusView = "kMsgNewFocusView"

Message send to all parents of the new focus view.

## ◆ kMsgOldFocusView

IdStringPtr kMsgOldFocusView = "kMsgOldFocusView"

Message send to all parents of the old focus view.

## ◆ kMsgViewSizeChanged

IdStringPtr kMsgViewSizeChanged = "kMsgViewSizeChanged"

Message send to parent that the size of the view has changed.

## ◆ kNormalFont

CFontRef kNormalFont = nullptr

## ◆ kNormalFontBig

CFontRef kNormalFontBig = nullptr

## ◆ kNormalFontSmall

CFontRef kNormalFontSmall = nullptr

## ◆ kNormalFontSmaller

CFontRef kNormalFontSmaller = nullptr

## ◆ kNormalFontVeryBig

CFontRef kNormalFontVeryBig = nullptr

## ◆ kNormalFontVerySmall

CFontRef kNormalFontVerySmall = nullptr

## ◆ kPerthousandSymbol

UTF8StringPtr kPerthousandSymbol = "\xE2\x80\xB0"

per mille sign

## ◆ kRedCColor

constexpr const CColor kRedCColor = CColor (255, 0, 0, 255)
| constexpr

## ◆ kRegisteredSymbol

UTF8StringPtr kRegisteredSymbol = "\xC2\xAE"

registered sign

## ◆ kStreamIOError

constexpr uint32_t kStreamIOError = (std::numeric_limits<uint32_t>::max) ()
| staticconstexpr

## ◆ kStreamSeekError

constexpr int64_t kStreamSeekError = -1
| staticconstexpr

## ◆ kSymbolFont

CFontRef kSymbolFont = nullptr

## ◆ kSystemFont

CFontRef kSystemFont = nullptr

## ◆ kTemplateAttributeMaxSize

constexpr auto kTemplateAttributeMaxSize = "maxSize"
| staticconstexpr

## ◆ kTemplateAttributeMinSize

constexpr auto kTemplateAttributeMinSize = "minSize"
| staticconstexpr

## ◆ kTrademarkSymbol

UTF8StringPtr kTrademarkSymbol = "\xE2\x84\xA2"

trade mark sign

## ◆ kTransparentCColor

constexpr const CColor kTransparentCColor = CColor (255, 255, 255, 0)
| constexpr

## ◆ kUIDescIdentifier

constexpr int64_t kUIDescIdentifier = 0x7072637365646975LL
| staticconstexpr

## ◆ kViewNameAttribute

CViewAttributeID kViewNameAttribute = 'cvcr'
| static

## ◆ kWhiteCColor

constexpr const CColor kWhiteCColor = CColor (255, 255, 255, 255)
| constexpr

## ◆ kYellowCColor

constexpr const CColor kYellowCColor = CColor (255, 255, 0, 255)
| constexpr

## ◆ unixPathSeparator

const int8_t unixPathSeparator = '/'
| static

## ◆ windowsPathSeparator

const int8_t windowsPathSeparator = '\\'
| static