VSTGUI: VSTGUI Namespace Reference

VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

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

- Namespace List
- Namespace Members

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 | PixelBuffer
namespace | Standalone
| Standalone Library
namespace | String
namespace | UIDescriptionPrivate
namespace | UIViewCreator
namespace | VST3EditorInternal
namespace | Xml

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

## 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
using | IdStringPtr = const char *
| ID String pointer.
using | UTF8StringPtr = const char *
| UTF8 String pointer.
using | UTF8StringBuffer = char *
| UTF8 String buffer pointer.
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 = uint32_t 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 | DragOperation { Copy, Move, None }
| Drag operation. More...
enum | EventType : uint32_t { Unknown, MouseDown, MouseMove, MouseUp, MouseCancel, MouseEnter, MouseExit, MouseWheel, ZoomGesture, KeyUp, KeyDown }
| EventType. More...
enum | MouseButton : uint32_t { None = 0, Left = 1 << 1, Middle = 1 << 2, Right = 1 << 3, Fourth = 1 << 4, Fifth = 1 << 5 }
| MouseButton. More...
enum | 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 | 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 }
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 | BitmapInterpolationQuality { kDefault = 0, kLow, kMedium, kHigh }
enum | CSliderMode { Touch, RelativeTouch, FreeClick, Ramp, UseGlobal }
enum | 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.
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.
template<typename T >
T | clamp (T value, T min, T max)
| Returns the value clamped to min and max.
template<typename T >
T | clampNorm (T value)
| Returns the value clamped to zero and one.
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.
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.
template<typename NormT , typename PlainT >
NormT | plainToNormalized (PlainT value, PlainT minValue, PlainT maxValue)
| Returns the normalized value from a plain one.
template<typename PlainT , typename NormT >
PlainT | normalizedToPlain (NormT value, PlainT minValue, PlainT maxValue)
| Returns the plain value from a normalized one.
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.
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.
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
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.
CButtonState | buttonStateFromEventModifiers (const Modifiers &mods)
| convert from new Modifiers to old CButtonState
CButtonState | buttonStateFromMouseEvent (const MouseEvent &event)
| convert from new MouseEvent to old CButtonState
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
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
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
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
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
MousePositionEvent & | castMousePositionEvent (Event &event)
| cast event to a mouse position event
MouseEvent & | castMouseEvent (Event &event)
| cast event to a mouse event
MouseDownEvent & | castMouseDownEvent (Event &event)
| cast event to a mouse down event
MouseMoveEvent & | castMouseMoveEvent (Event &event)
| cast event to a mouse move event
MouseUpEvent & | castMouseUpEvent (Event &event)
| cast event to a mouse up event
MouseEnterEvent & | castMouseEnterEvent (Event &event)
| cast event to a mouse enter event
MouseExitEvent & | castMouseExitEvent (Event &event)
| cast event to a mouse exit event
MouseCancelEvent & | castMouseCancelEvent (Event &event)
| cast event to a mouse cancel event
MouseWheelEvent & | castMouseWheelEvent (Event &event)
| cast event to a mouse wheel event
ZoomGestureEvent & | castZoomGestureEvent (Event &event)
| cast event to a zoom gesture event
KeyboardEvent & | castKeyboardEvent (Event &event)
| cast event to a mouse wheel event
unsigned char | toVstVirtualKey (VirtualKey key)
| helper function to convert from new VirtualKey to old VstVirtualKey
VirtualKey | fromVstVirtualKey (uint32_t key)
template<class F >
auto | finally (F &&f) noexcept
DataPackageIterator | begin (IDataPackage *pkg)
DataPackageIterator | end (IDataPackage *pkg)
class | deprecated ("Please use listeners instead")]] IDependency
| simple dependency between objects.
class | deprecated ("Use IViewListener/IViewEventListener instead")]] IViewMouseListener
| View Mouse Listener Interface.
class deprecated("Use ViewListenerAdapter/ViewEventListenerAdapter instead")]] ViewMouseListenerAdapter CMouseEventResult | viewOnMouseUp (CView *view, CPoint pos, CButtonState buttons) override
| View Mouse Listener Interface Adapter.
CMouseEventResult | viewOnMouseMoved (CView *view, CPoint pos, CButtonState buttons) override
CMouseEventResult | viewOnMouseCancel (CView *view) override
void | viewOnMouseEntered (CView *view) override
void | viewOnMouseExited (CView *view) override
void | viewOnMouseEnabled (CView *view, bool state) override
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.
void | exit ()
| exit using the VSTGUI library.
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.
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
template<typename T >
T * | findViewController (const CViewContainer *view)
| helper method to find a specific controller inside a view hierarchy
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)
class deprecated("Please use your own VSTGUIEditorInterface subclass")]] PluginGUIEditor | ~PluginGUIEditor () override
virtual void | setParameter (int32_t index, float value)
virtual bool | getRect (ERect **ppRect)
virtual bool | open (void *ptr)
virtual void | close ()
virtual void | idle ()
void | doIdleStuff () override
void * | getEffect ()
int32_t | getVstGuiVersion ()
virtual int32_t | setKnobMode (int32_t val)
int32_t | getKnobMode () const override
void | beginEdit (int32_t index) override
void | endEdit (int32_t index) override
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.
IdStringPtr | kMsgOldFocusView = "kMsgOldFocusView"
| Message send to all parents of the old focus view.
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 | kCKnobRange = 200.f
static constexpr CViewAttributeID | kCKnobMouseStateAttribute = 'knms'
UTF8StringPtr | kDegreeSymbol = "\xC2\xB0"
| degree sign
UTF8StringPtr | kInfiniteSymbol = "\xE2\x88\x9E"
| infinity sign
UTF8StringPtr | kCopyrightSymbol = "\xC2\xA9"
| copyright sign
UTF8StringPtr | kTrademarkSymbol = "\xE2\x84\xA2"
| trade mark sign
UTF8StringPtr | kRegisteredSymbol = "\xC2\xAE"
| registered sign
UTF8StringPtr | kMicroSymbol = "\xC2\xB5"
| micro sign
UTF8StringPtr | kPerthousandSymbol = "\xE2\x80\xB0"
| per mille sign
IdStringPtr | kMsgViewSizeChanged = "kMsgViewSizeChanged"
| Message send to parent that the size of the view has changed.
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)
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'
ERect | rect
void * | effect
void * | systemWindow
static int32_t | knobMode

## Typedef Documentation

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

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

using CConstMenuItemIterator = CMenuItemList::const_iterator

using CCoord = double

coordinate type

using CFontRef = CFontDesc*

using CMenuItemIterator = CMenuItemList::iterator

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

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

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

using CViewAttributeID = size_t

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

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

using IdStringPtr = const char*

ID String pointer.

using InterfacePtr = std::shared_ptr<Interface>

using LineList = std::vector<LinePair>

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

using ModalViewSessionID = uint32_t

using NonAtomicReferenceCounted = ReferenceCounted<int32_t>

using PlatformBitmapPtr = SharedPointer<IPlatformBitmap>

using PlatformFactoryPtr = std::unique_ptr<IPlatformFactory>

using PlatformFileSelectorPtr = std::shared_ptr<IPlatformFileSelector>

using PlatformFontPtr = SharedPointer<IPlatformFont>

using PlatformFramePtr = uint32_t SharedPointer<IPlatformFrame>
| strong

using PlatformGradientPtr = std::unique_ptr<IPlatformGradient>

using PlatformGraphicsDeviceContextPtr = std::shared_ptr<IPlatformGraphicsDeviceContext>

using PlatformGraphicsDevicePtr = std::shared_ptr<IPlatformGraphicsDevice>

using PlatformGraphicsPathFactoryPtr = std::shared_ptr<IPlatformGraphicsPathFactory>

using PlatformGraphicsPathPtr = std::unique_ptr<IPlatformGraphicsPath>

using PlatformResourceInputStreamPtr = std::unique_ptr<IPlatformResourceInputStream>

using PlatformStringPtr = SharedPointer<IPlatformString>

using PlatformTimerPtr = SharedPointer<IPlatformTimer>

using PointList = std::vector<CPoint>

using ReverseViewIterator = CViewContainer::Iterator<true>

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

using UTF8StringBuffer = char*

UTF8 String buffer pointer.

using UTF8StringPtr = const char*

UTF8 String pointer.

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

using ViewIterator = CViewContainer::Iterator<false>

## Enumeration Type Documentation

enum BitmapInterpolationQuality

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

enum ByteOrder

Enumerator
kBigEndianByteOrder |
kLittleEndianByteOrder |
kNativeByteOrder |

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.

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

enum CDrawModeFlags : uint32_t

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

enum CDrawStyle

Enumerator
kDrawStroked |
kDrawFilled |
kDrawFilledAndStroked |

enum CHoriTxtAlign

Enumerator
kLeftText |
kCenterText |
kRightText |

enum CKnobMode

Enumerator
kCircularMode |
kRelativCircularMode |
kLinearMode |

enum CMessageResult

Enumerator
kMessageUnknown |
kMessageNotified |

enum CMouseEventResult

Enumerator
kMouseEventNotImplemented |
kMouseEventHandled |
kMouseEventNotHandled |
kMouseDownEventHandledButDontNeedMovedOrUpEvents |
kMouseMoveEventHandledButDontNeedMoreEvents |

enum CMouseWheelAxis

Enumerator
kMouseWheelAxisX |
kMouseWheelAxisY |

enum CSliderMode

Enumerator
Touch |
RelativeTouch |
FreeClick |
Ramp |
UseGlobal |

enum CTxtFace

Enumerator
kNormalFace |
kBoldFace |
kItalicFace |
kUnderlineFace |
kStrikethroughFace |

enum CViewAutosizing

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

enum DragResult

Enumerator
kDragRefused |
kDragMoved |
kDragCopied |
kDragError |

enum SeekMode

Enumerator
Set |
Current |
End |

## Function Documentation

~PluginGUIEditor | ( |  | ) |
| override

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

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

void VSTGUI::beginEdit | ( | int32_t | index | ) |
| override

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

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

Returns the value clamped to min and max.

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

Returns the value clamped to zero and one.

virtual void VSTGUI::close | ( |  | ) |
| virtual

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

Convert between Platform Pixel Accessor pixel format and PixelBuffer format.

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

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

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

void VSTGUI::doIdleStuff | ( |  | ) |
| override

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

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

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

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

void VSTGUI::endEdit | ( | int32_t | index | ) |
| override

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

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

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

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

helper method to find a specific controller inside a view hierarchy

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

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

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

void* VSTGUI::getEffect | ( |  | ) |

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

int32_t VSTGUI::getKnobMode | ( |  | ) | const
| override

virtual bool VSTGUI::getRect | ( | ERect ** | ppRect | ) |
| virtual

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

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

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

helper method to get the controller of a view

int32_t VSTGUI::getVstGuiVersion | ( |  | ) |

bool hasAssertionHandler | ( |  | ) |

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

virtual void VSTGUI::idle | ( |  | ) |
| virtual

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

Returns the index of the value.

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

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

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

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

white-character test

Parameters

  character | UTF-32 character

Returns
  true if character is a white-character

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

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

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

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

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

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

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

enum EventType uint32_t enum VirtualKey uint32_t enum ModifierKey uint32_t const Event & noEvent | ( |  | ) |
| inlinestrong

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

Returns the plain value from a normalized one.

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

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

virtual bool VSTGUI::open | ( | void * | ptr | ) |
| virtual

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

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

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

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

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

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

Returns the normalized value from a plain one.

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

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

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

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

void setAssertionHandler | ( | AssertionHandler | handler | ) |

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

virtual int32_t VSTGUI::setKnobMode | ( | int32_t | val | ) |
| virtual

virtual void VSTGUI::setParameter | ( | int32_t | index,
|  | float | value
| ) |  |
| virtual

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

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

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

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

Returns the normalized value from the step value.

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

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

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

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

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

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

CMouseEventResult VSTGUI::viewOnMouseCancel | ( | CView * | view | ) |
| override

void VSTGUI::viewOnMouseEnabled | ( | CView * | view,
|  | bool | state
| ) |  |
| override

void VSTGUI::viewOnMouseEntered | ( | CView * | view | ) |
| override

void VSTGUI::viewOnMouseExited | ( | CView * | view | ) |
| override

CMouseEventResult VSTGUI::viewOnMouseMoved | ( | CView * | view,
|  | CPoint | pos,
|  | CButtonState | buttons
| ) |  |
| override

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

## Variable Documentation

AssertionHandler assertionHandler = nullptr
| static

void* effect

GlobalFonts globalFonts
| static

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

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

CCoord kCheckBoxTitleMargin = 5
| static

constexpr CViewAttributeID kCKnobMouseStateAttribute = 'knms'
| static

const float kCKnobRange = 200.f
| static

UTF8StringPtr kCopyrightSymbol = "\xC2\xA9"

copyright sign

constexpr CViewAttributeID kCViewAlphaValueAttrID = 'cvav'
| static

constexpr CViewAttributeID kCViewAttributeReferencePointer = 'cvrp'
| static

constexpr CViewAttributeID kCViewBackgroundBitmapAttrID = 'cvbb'
| static

const CViewAttributeID kCViewContainerBackgroundOffsetAttribute = 'vcbo'

const CViewAttributeID kCViewContainerDropTargetAttribute = 'vcdt'

const CViewAttributeID kCViewContainerLastDrawnFocusAttribute = 'vclf'

const CViewAttributeID kCViewContainerMouseDownViewAttribute = 'vcmd'

constexpr CViewAttributeID kCViewControllerAttribute = 'ictr'
| static

constexpr CViewAttributeID kCViewCustomDropTargetAttrID = 'cvdt'
| static

constexpr CViewAttributeID kCViewDisabledBackgroundBitmapAttrID = 'cvdb'
| static

constexpr CViewAttributeID kCViewHitTestPathAttrID = 'cvht'
| static

constexpr CViewAttributeID kCViewMouseableAreaAttrID = 'cvma'
| static

constexpr CViewAttributeID kCViewTooltipAttribute = 'cvtt'
| static

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

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

UTF8StringPtr kDegreeSymbol = "\xC2\xB0"

degree sign

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

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

UTF8StringPtr kInfiniteSymbol = "\xE2\x88\x9E"

infinity sign

const CLineStyle kLineOnOffDash

const CLineStyle kLineSolid {}

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

UTF8StringPtr kMicroSymbol = "\xC2\xB5"

micro sign

IdStringPtr kMsgLooseFocus = "LooseFocus"

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

IdStringPtr kMsgNewFocusView = "kMsgNewFocusView"

Message send to all parents of the new focus view.

IdStringPtr kMsgOldFocusView = "kMsgOldFocusView"

Message send to all parents of the old focus view.

IdStringPtr kMsgViewSizeChanged = "kMsgViewSizeChanged"

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

int32_t knobMode
| static

CFontRef kNormalFont = nullptr

CFontRef kNormalFontBig = nullptr

CFontRef kNormalFontSmall = nullptr

CFontRef kNormalFontSmaller = nullptr

CFontRef kNormalFontVeryBig = nullptr

CFontRef kNormalFontVerySmall = nullptr

UTF8StringPtr kPerthousandSymbol = "\xE2\x80\xB0"

per mille sign

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

UTF8StringPtr kRegisteredSymbol = "\xC2\xAE"

registered sign

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

constexpr int64_t kStreamSeekError = -1
| static

CFontRef kSymbolFont = nullptr

CFontRef kSystemFont = nullptr

constexpr auto kTemplateAttributeMaxSize = "maxSize"
| static

constexpr auto kTemplateAttributeMinSize = "minSize"
| static

UTF8StringPtr kTrademarkSymbol = "\xE2\x84\xA2"

trade mark sign

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

constexpr int64_t kUIDescIdentifier = 0x7072637365646975LL
| static

CViewAttributeID kViewNameAttribute = 'cvcr'
| static

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

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

ERect rect

void* systemWindow

const int8_t unixPathSeparator = '/'
| static

const int8_t windowsPathSeparator = '\\'
| static