VSTGUI

https://steinbergmedia.github.io/vst3_doc/vstgui/html/
Admin
VSTGUI is a user interface toolkit for creating graphical interfaces in audio plug-ins (VST,...
Tokens:1,999,902
Snippets:17,187
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### VSTGUI Introduction and Setup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_u_i_desc_1_1_value_calls

Covers the introductory aspects of the VSTGUI framework and provides guidance on its setup. This includes information on getting started with the library and its basic configuration.

--------------------------------

### VSTGUI Introduction and Setup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_u_i_desc_1_1_value_calls-members

Covers the introductory aspects of the VSTGUI framework and provides guidance on its setup. This includes information on getting started with the library and its basic configuration.

--------------------------------

### VSTGUI Introduction and Setup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_u_i_desc_1_1_model_binding_callbacks-members

Covers the introductory aspects of the VSTGUI framework and provides guidance on its setup. This includes information on getting started with the library and its basic configuration.

--------------------------------

### VSTGUI 4.10 Introduction and Setup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_layouting_1_1_auto_layout

Provides an overview of the VSTGUI 4.10 framework, including its purpose, setup instructions, and new features. It serves as a starting point for developers.

--------------------------------

### VSTGUI 4.10 Introduction and Setup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_layouting_1_1_auto_layout-members

Provides an overview of the VSTGUI 4.10 framework, including its purpose, setup instructions, and new features. It serves as a starting point for developers.

--------------------------------

### Get Start Angle - CKnobBase

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Retrieves the starting angle for a knob control. This method is specific to the CKnobBase class.

```C++
CKnobBase::getStartAngle()
```

--------------------------------

### Get Start Angle - CKnobBase

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Retrieves the starting angle for a knob control. This method is specific to the CKnobBase class.

```C++
CKnobBase::getStartAngle()
```

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_view_adapter

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### Initialize VSTGUI Application

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_application_1_1_init

Initializes the VSTGUI application by taking a delegate and an optional configuration object. This is a crucial step for setting up the application's core components.

```C++
explicit Init(DelegatePtr &&_delegate_, Configuration &&_config_ = {});
```

--------------------------------

### CKnobBase Angle Properties

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_knob-members

Inline virtual methods to get the range angle and start angle of the knob.

```C++
getRangeAngle() const| CKnobBase| inlinevirtual
```

```C++
getStartAngle() const| CKnobBase| inlinevirtual
```

--------------------------------

### Initialize VSTGUI Application

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_application_1_1_init

This snippet shows how to initialize the VSTGUI application. It requires including the 'appinit.h' header file.

```cpp
#include <appinit.h>

// Function to initialize the application
void initializeApplication();
```

--------------------------------

### CKnobBase Getters for Angles and Zoom

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_anim_knob-members

Methods to get the range angle, start angle, and zoom factor for a CKnobBase.

```C++
inline virtual float getRangeAngle() const;
inline virtual float getStartAngle() const;
inline CCoord getZoomFactor() const;
```

--------------------------------

### Setup UI in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_s

Function to set up the user interface, likely for data browser sources.

```C++
setupUI(GenericStringListDataBrowserSource* source)
```

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_i_view-members

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### VSTGUI ViewCreatorRegistry: Get Iterator to Beginning

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_view_creator_registry

The `begin` function returns a `const_iterator` pointing to the first element in the `ViewCreatorRegistryMap`. This is used to start iterating through the registered view creators.

```C++
const_iterator begin ()
```

--------------------------------

### CAnimKnob Angle and Range Settings

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_anim_knob

Functions to set and get the start angle and range angle of the knob, allowing customization of its rotational behavior and the visual sweep of its movement.

```C++
virtual void setStartAngle (float val)
virtual float getStartAngle () const
virtual void setRangeAngle (float val)
virtual float getRangeAngle () const
```

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_int_rect

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_int_size

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### PluginGUIEditor Parameter and State Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_plugin_g_u_i_editor

Methods for setting and getting plugin parameters, managing knob modes, and retrieving editor state. Includes functions for starting and ending parameter edits.

```C++
virtual void setParameter(int32_t index, float value)
int32_t getKnobMode() const override
void beginEdit(int32_t index) override
void endEdit(int32_t index) override
```

--------------------------------

### Get Multi-Frame Bitmap Range (C++)

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_multi_frame_bitmap_view

Retrieves the current drawing range for the CMultiFrameBitmap. This function returns a pair of integers representing the start and end indices of the frames currently in use.

```C++
std::pair< int32_t, int32_t > getMultiFrameBitmapRange () const
```

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_int_size-members

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_i_view_embedder

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### VSTGUI CView Drag and Drop

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_view

Methods for initiating and managing drag-and-drop operations, including starting a drag, getting and setting the drop target, and performing drag operations with data packages.

```C++
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})

```

```C++
virtual SharedPointer< IDropTarget > getDropTarget ()

```

```C++
void setDropTarget (const SharedPointer< IDropTarget > &dt)

```

```C++
DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)

```

--------------------------------

### Initialize UI Description and View Controllers in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_s

Functions for setting up shared resources and configuring view switch controllers.

```C++
setSharedResources(UIDescription* description, SharedPointer<ISharedResources> resources)
setSwitchControlTag(UIDescriptionViewSwitchController* controller, int tag)
```

--------------------------------

### CView Drag and Drop Operations

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_open_g_l_view

Handles the initiation and management of drag and drop operations. This includes starting a drag, getting and setting the drop target.

```C++
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})

virtual SharedPointer< IDropTarget > getDropTarget ()

void setDropTarget (const SharedPointer< IDropTarget > &dt)

DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_layouting

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CVSTGUITimer Timer Control Methods

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_v_s_t_g_u_i_timer-members

Provides methods to control the timer's behavior, including starting, stopping, and setting the fire time. It also includes a method to get the current fire time.

```C++
setFireTime(uint32_t newFireTime)
start()
stop()
getFireTime() const
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_c_clipboard_detail

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Drag and Drop Operations

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_rocker_switch

Methods for initiating and managing drag and drop operations. This includes starting a drag, getting the drop target, setting a custom drop target, and handling data packages during a drag.

```C++
bool doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})

virtual SharedPointer< IDropTarget > getDropTarget ()

void setDropTarget (const SharedPointer< IDropTarget > &dt)

DragResult doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
```

--------------------------------

### Get Container Information

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Methods to get a container at a specific index from CFrame or CViewContainer, and to get the size of a CScrollView.

```C++
getContainerAt() : CFrame, CViewContainer
getContainerSize() : CScrollView
```

--------------------------------

### VSTGUI 4.10 Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_external_view_1_1_int_rect-members

This section provides an overview of the VSTGUI 4.10 framework, including its introduction, setup, new features, license, and guidelines for creating user interfaces. It also covers standalone library usage and miscellaneous topics.

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_string

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Get Container Information

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Methods to get a container at a specific index from CFrame or CViewContainer, and to get the size of a CScrollView.

```C++
getContainerAt() : CFrame, CViewContainer
getContainerSize() : CScrollView
```

--------------------------------

### CVSTGUITimer: start() Method

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_v_s_t_g_u_i_timer

The start() method initiates the timer. It returns a boolean indicating whether the timer was successfully started.

```C++
bool start()
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_detail

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_xml

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Start VSTGUI Group Tasks

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_async_1_1_group

Starts the execution of all tasks within the group. An optional finishTask can be provided to run after all group tasks are completed. The group can only be started once.

```C++
bool start(Task &&finishTask = nullptr)
```

--------------------------------

### VSTGUI IWindow: Get Type

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_i_window

Gets the type of the window.

```C++
virtual WindowType getType () const =0
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_v_s_t3_editor_internal

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CControl Value Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_scrollbar

Functions to get and set the value of a control, both in raw and normalized formats. It also includes functions to set and get the minimum, maximum, and default values, as well as a function to get the range.

```C++
virtual void setValue (float val)
virtual float getValue () const
virtual void setValueNormalized (float val)
virtual float getValueNormalized () const
virtual void setMin (float val)
virtual float getMin () const
virtual void setMax (float val)
virtual float getMax () const
float getRange () const
virtual void setOldValue (float val)
virtual float getOldValue () const
virtual void setDefaultValue (float val)
virtual float getDefaultValue () const
virtual void bounceValue ()
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_u_i_view_creator

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CControl Get Value

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_movie_button

Gets the current value of the control. Inherited from CControl.

```C++
virtual float getValue () const
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_call

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Start Drag Operation in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_view

Initiates a drag operation. It can be started from onMouseDown or onMouseMove, and accepts drag description and an optional callback for results. A deprecated version also exists for starting drags with a source data package.

```C++
bool doDrag(const DragDescription& _dragDescription, const SharedPointer<IDragCallback>& _callback = {}) DragResult doDrag(IDataPackage* _source, const CPoint& _offset = CPoint(0, 0), CBitmap* _dragBitmap = nullptr)
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_c_draw_methods

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### VSTGUI: Initialization Methods

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_i

Provides various initialization methods for different VSTGUI components, including frames, bitmaps, and editors.

```C++
Init() : Init
init() : ExchangeViewAnimation, CBitmapPixelAccess, CDrawContext, CFileExtension, CFontDesc, DragStartMouseObserver, IViewSwitchController, VST3Editor
```

--------------------------------

### VSTGUI IWindow: Get Size

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_i_window

Gets the current size of the client area of the window.

```C++
virtual CPoint getSize () const =0
```

--------------------------------

### CTextEdit Platform Get Size

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_text_edit-members

Protected method to get the platform-specific size of the CTextEdit.

```C++
platformGetSize() const override
```

--------------------------------

### VST3 VSTGUI Initialization and Cleanup

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_bitmap_filter_1_1_standard

This snippet includes functions for initialization and cleanup, such as `init` and `exit`, and a `finally` block for resource management in VSTGUI.

```C++
init
exit
finally
```

--------------------------------

### Initialize VSTGUI (VSTGUI)

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i

Initializes the VSTGUI library with the provided platform instance handle. This must be called before using most VSTGUI functionalities.

```C++
void init (PlatformInstanceHandle instance)
```

--------------------------------

### Get Draw Background

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_param_display

Gets the bitmap that is drawn for the view, considering its enabled state.

```C++
CBitmap * getDrawBackground () const
```

--------------------------------

### CTextEdit Platform Get Text

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_text_edit-members

Protected method to get the platform-specific text content of the CTextEdit.

```C++
platformGetText() const override
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_animation

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Attribute Manipulation in VSTGUI CView

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_view

Provides methods for getting and setting attributes of a view. Supports retrieving attribute size, getting attribute data, setting attribute data, removing attributes, and templated methods for setting and getting attributes of specific types.

```C++
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
bool removeAttribute (const CViewAttributeID id)
template<typename T>
bool setAttribute (const CViewAttributeID id, const T &data)
template<typename T>
bool getAttribute (const CViewAttributeID id, T &data) const
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_external_view

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### Get View Controller

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i

Helper method to get the controller of a view. It can optionally perform a deep search.

```C++
IController * getViewController(const CView * _view_, bool _deep_ = false)
```

--------------------------------

### VSTGUI Window Controller

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_b

Method to prepare a window controller before it is shown.

```C++
IWindowController::beforeShow()
WindowControllerAdapter::beforeShow()
```

--------------------------------

### Initialize VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/group__new__in__4__10

Initializes the VSTGUI library. This function must be called before using any VSTGUI functionalities. The 'instance' parameter depends on the platform: HINSTANCE on Windows, CFBundleRef on macOS, and void* on Linux.

```C++
void init (PlatformInstanceHandle instance)
```

--------------------------------

### CTextEdit Platform Get Visible Size

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_text_edit-members

Protected method to get the platform-specific visible size of the CTextEdit.

```C++
platformGetVisibleSize
```

--------------------------------

### CControl Get Normalized Value

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_movie_button

Gets the normalized value of the control (between 0.0 and 1.0). Inherited from CControl.

```C++
virtual float getValueNormalized () const
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_constants

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CView Creation Example

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_anim_knob-members

Illustrates the creation of a CView object, a fundamental UI element in VSTGUI.

```C++
newCopy() const override| CAnimKnob| inlinevirtual
```

--------------------------------

### Start Timer and Operations in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_s

Functions to start timers and initiate operations for groups and content providers.

```C++
start(CVSTGUITimer* timer)
start(Group* group)
start(InputStreamContentProvider* provider)
start(UTF8CharacterIterator* iterator)
start(ZLibInputContentProvider* provider)
```

--------------------------------

### Get Clear Mark Properties from CSearchTextEdit

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Provides methods to get the inset and rectangle of the clear mark in a CSearchTextEdit.

```C++
getClearMarkInset() : CSearchTextEdit
getClearMarkRect() : CSearchTextEdit
```

--------------------------------

### Delegation and Controller Methods in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_d

This section covers methods related to delegation patterns and controller management within VSTGUI. It includes the initialization of delegate adapters and delegation controllers.

```c++
DelegateAdapter() : DelegateAdapter;
DelegationController() : DelegationController;
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_u_i_description_listener_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to core functionalities, UI elements, and utilities.

```Documentation
VST3Editor
VSTGUI
Animation
BitmapFilter
CClipboardDetail
ExternalView
Layouting
Standalone
UIDescriptionPrivate
UIViewCreator
Xml
AEffGUIEditor
AspectRatioVST3Editor
Base64Codec
BitScopeToggleT
Buffer
BufferedOutputStream
CAnimationSplashScreen
CAnimKnob
CAutoAnimation
CAutoLayoutContainerView
CBaseObject
CBaseObjectGuard
CBitmap
CBitmapPixelAccess
CButtonState
CCheckBox
CClipboard
CColor
CColorChooser
CColorChooserUISettings
CCommandMenuItem
CControl
CDataBrowser
CDragContainerHelper
CDrawContext
CDrawMode
CDropSource
CExternalControl
CExternalView
CExternalViewBaseImpl
CFileExtension
CFileStream
CFontChooser
CFontChooserUIDefinition
CFontDesc
CFrame
CGradient
CGradientView
CGraphicsPath
CGraphicsTransform
CHorizontalSlider
CHorizontalSwitch
CInvalidRectList
CKickButton
CKnob
```

--------------------------------

### Get Clear Mark Properties from CSearchTextEdit

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Provides methods to get the inset and rectangle of the clear mark in a CSearchTextEdit.

```C++
getClearMarkInset() : CSearchTextEdit
getClearMarkRect() : CSearchTextEdit
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_pixel_buffer

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CTextEdit Platform Get Text Inset

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_text_edit-members

Protected method to get the platform-specific inset for the text within the CTextEdit.

```C++
platformGetTextInset() const override
```

--------------------------------

### VSTGUI Initialization and Resource Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_bitmap_filter

Provides functions for initializing VSTGUI components and managing platform-specific resources.

```C++
init

FreeNodePlatformResources
```

--------------------------------

### CControl Get Min/Max Value

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_movie_button

Gets the minimum and maximum values for the control's range. Inherited from CControl.

```C++
virtual float getMin () const
virtual float getMax () const
```

--------------------------------

### CView Constructors and Methods

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_animation_splash_screen-members

Outlines the constructors for CView, including basic size initialization. Covers a wide range of methods for view management, drawing, event handling, attribute access, and transformations.

```C++
CView(const CRect &size)
CView(const CView &view)
checkUpdate(const CRect &updateRect) const
dispatchEvent(Event &event)
doDrag(const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback = {})
doDrag(IDataPackage *source, const CPoint &offset = CPoint(0, 0), CBitmap *dragBitmap = nullptr)
drawRect(CDrawContext *pContext, const CRect &updateRect)
frameToLocal(CPoint &point) const
getAlphaValue() const
getAttribute(const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
getAttribute(const CViewAttributeID id, T &data) const
getAttributeSize(const CViewAttributeID id, uint32_t &outSize) const
getAutosizeFlags() const
getBackground() const
getDisabledBackground() const
getDrawBackground() const
getDropTarget()
getEditor() const
getFocusPath(CGraphicsPath &outPath) override
getFrame() const
getGlobalTransform(bool ignoreFrame = false) const
getHeight() const
getHitTestPath() const
getMouseableArea() const
getMouseableArea(CRect &rect) const
getMouseEnabled() const
getParentView() const
getTransparency() const
getViewSize() const
getVisibleViewSize() const
hasViewFlag(int32_t bit) const
idleRate
invalid()
invalidRect(const CRect &rect)
isAttached() const
isSubview() const
isVisible() const
```

--------------------------------

### Start Timer

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_auto_animation

Starts the internal timer that drives the animation. This method should be called when the control is ready to begin animating.

```C++
void startTimer ()
```

--------------------------------

### VSTGUI 4.10 UI Creation and Standalone Library

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_layouting_1_1_auto_layout

Details on how to create user interfaces using VSTGUI 4.10 and information about the standalone library. This section covers the core aspects of building UIs with the framework.

--------------------------------

### VSTGUI IWindow: Get Auto Save Frame Name

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_i_window

Gets the name used for auto-saving the window's frame.

```C++
virtual const UTF8String & getAutoSaveFrameName () const =0
```

--------------------------------

### VSTGUI View Creation and Configuration

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_e

Includes functionalities for creating and configuring views, such as view factories and enabling tooltips.

```C++
UIViewFactory evaluateAttributesAndRemember();
void enableTooltips();
```

--------------------------------

### Start Drag Operation

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_external_control

Initiates a drag-and-drop operation with the provided drag description. This method is used internally to start dragging.

```C++
bool | doDrag (const DragDescription &dragDescription, const SharedPointer< IDragCallback > &callback={})  
 | start a drag operation
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_option_menu_listener_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Set Start Angle in CKnobBase

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_anim_knob-members

Sets the starting angle for a knob in the CKnobBase class. This determines the initial orientation of the knob.

```C++
setStartAngle(float val)
```

--------------------------------

### Get Slider and Knob Properties

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Methods specific to sliders and knobs, such as getting handle positions, line widths, and knob modes.

```C++
getHandle() : CSlider
getHandleLineWidth() : CKnob
getHandleMinPosPrivate() : CSliderBase
getHandleSizePrivate() : CSliderBase
getKnobMode() : AEffGUIEditor, CFrame, PluginGUIEditor, VSTGUIEditorInterface
getKnobRange() : CKnobBase
getOffset() : CSlider, CSwitchBase
getOffsetHandle() : CSliderBase
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_text_label_listener_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to core functionalities, UI elements, and utilities.

```Documentation
VST3Editor
VSTGUI
Animation
BitmapFilter
CClipboardDetail
ExternalView
Layouting
Standalone
UIDescriptionPrivate
UIViewCreator
Xml
AEffGUIEditor
AspectRatioVST3Editor
Base64Codec
BitScopeToggleT
Buffer
BufferedOutputStream
CAnimationSplashScreen
CAnimKnob
CAutoAnimation
CAutoLayoutContainerView
CBaseObject
CBaseObjectGuard
CBitmap
CBitmapPixelAccess
CButtonState
CCheckBox
CClipboard
CColor
CColorChooser
CColorChooserUISettings
CCommandMenuItem
CControl
CDataBrowser
CDragContainerHelper
CDrawContext
CDrawMode
CDropSource
CExternalControl
CExternalView
CExternalViewBaseImpl
CFileExtension
CFileStream
CFontChooser
CFontChooserUIDefinition
CFontDesc
CFrame
CGradient
CGradientView
CGraphicsPath
CGraphicsTransform
CHorizontalSlider
CHorizontalSwitch
CInvalidRectList
CKickButton
CKnob
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_view_creator_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Get Slider and Knob Properties

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Methods specific to sliders and knobs, such as getting handle positions, line widths, and knob modes.

```C++
getHandle() : CSlider
getHandleLineWidth() : CKnob
getHandleMinPosPrivate() : CSliderBase
getHandleSizePrivate() : CSliderBase
getKnobMode() : AEffGUIEditor, CFrame, PluginGUIEditor, VSTGUIEditorInterface
getKnobRange() : CKnobBase
getOffset() : CSlider, CSwitchBase
getOffsetHandle() : CSliderBase
```

--------------------------------

### VSTGUI XML and UI Description Handling

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/namespace_v_s_t_g_u_i_1_1_standalone_1_1_commands_1_1_debug

This section lists classes for handling XML parsing and UI description loading within VSTGUI, including private implementations and view creators.

```C++
class UIDescriptionPrivate;
class UIViewCreator;
class CompressedUIDescription;
class CResourceDescription;
```

--------------------------------

### Attribute Management

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_text_button

Methods for getting, setting, and removing attributes associated with a view. Supports generic types for setting and getting attributes.

```C++
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
bool getAttribute (const CViewAttributeID id, const uint32_t inSize, void *outData, uint32_t &outSize) const
bool setAttribute (const CViewAttributeID id, const uint32_t inSize, const void *inData)
bool removeAttribute (const CViewAttributeID id)
template<typename T>
bool setAttribute (const CViewAttributeID id, const T &data)
template<typename T>
bool getAttribute (const CViewAttributeID id, T &data) const
```

--------------------------------

### Initialize VSTGUI with Delegate and Configuration

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/struct_v_s_t_g_u_i_1_1_standalone_1_1_application_1_1_init-members

This snippet shows the explicit constructor for the 'Init' class in VSTGUI. It takes a delegate and an optional configuration object to initialize the framework.

```C++
Init(DelegatePtr &&delegate, Configuration &&config={})
```

--------------------------------

### Get Mouseable Area (Reference)

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_horizontal_slider

Retrieves the mouseable area of the view by reference. This is an alternative way to get the mouseable area.

```C++
CRect & | getMouseableArea (CRect &rect) const
 | get the area in which the view reacts to the mouse
```

--------------------------------

### Handle Start Local Event Loop in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_o

This snippet covers classes that handle starting a local event loop, such as CFrame.

```c++
/*
 * onStartLocalEventLoop() : CFrame
 */
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_u_i_description_listener_adapter-members

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Get Cell Information in CDataBrowser

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Retrieves the cell at a specified index from a CDataBrowser. Also provides a method to get the bounding rectangle of a cell.

```C++
getCellAt() : CDataBrowser
getCellBounds() : CDataBrowser
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_view_creator_adapter-members

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Get Cell Information in CDataBrowser

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Retrieves the cell at a specified index from a CDataBrowser. Also provides a method to get the bounding rectangle of a cell.

```C++
getCellAt() : CDataBrowser
getCellBounds() : CDataBrowser
```

--------------------------------

### VSTGUI 4.10 UI Creation and Standalone Library

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_layouting_1_1_auto_layout-members

Details on how to create user interfaces using VSTGUI 4.10 and information about the standalone library. This section covers the core aspects of building UIs with the framework.

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_view_container_listener_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### VSTGUI IWindow: Get Focus View Rect

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_i_window

Gets the rectangular area of the currently focused view, relative to the window's frame.

```C++
virtual CRect getFocusViewRect () const =0
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_command_menu_item_target_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Get VSTGUI Application Instance

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_standalone_1_1_i_application-members

A static method to get the singleton instance of the IApplication interface. This provides access to the main application object.

```C++
instance()
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_old_mouse_observer_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### CMovieButton Get Inverse Index

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_movie_button

Gets the inverse index for a given index within a CMultiFrameBitmap. This can be useful for specific drawing or logic scenarios.

```C++
uint16_t getInverseIndex (const CMultiFrameBitmap &mfb, uint16_t index) const
```

--------------------------------

### Get Attribute Size in VSTGUI CView

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_data_browser

Retrieves the size of a specific view attribute. This is useful before attempting to get or set attribute data.

```C++
bool getAttributeSize (const CViewAttributeID id, uint32_t &outSize) const
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_data_browser_delegate_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Start Angle Member Data (CKnobBase)

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_knob_base

The startAngle member data of CKnobBase stores the starting angle of the knob as a float. It is a protected member.

```C++
float startAngle;
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_view_listener_adapter

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Start Drag Operation with Data Package in VSTGUI

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_c_knob

Starts a drag operation using an IDataPackage, specifying an offset and an optional drag bitmap.

```C++
DragResult | doDrag (IDataPackage *source, const CPoint &offset=CPoint(0, 0), CBitmap *dragBitmap=nullptr)
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_command_menu_item_target_adapter-members

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to core functionalities, UI elements, and utilities.

```Documentation
VST3Editor
VSTGUI
Animation
BitmapFilter
CClipboardDetail
ExternalView
Layouting
Standalone
UIDescriptionPrivate
UIViewCreator
Xml
AEffGUIEditor
AspectRatioVST3Editor
Base64Codec
BitScopeToggleT
Buffer
BufferedOutputStream
CAnimationSplashScreen
CAnimKnob
CAutoAnimation
CAutoLayoutContainerView
CBaseObject
CBaseObjectGuard
CBitmap
CBitmapPixelAccess
CButtonState
CCheckBox
CClipboard
CColor
CColorChooser
CColorChooserUISettings
CCommandMenuItem
CControl
CDataBrowser
CDragContainerHelper
CDrawContext
CDrawMode
CDropSource
CExternalControl
CExternalView
CExternalViewBaseImpl
CFileExtension
CFileStream
CFontChooser
CFontChooserUIDefinition
CFontDesc
CFrame
CGradient
CGradientView
CGraphicsPath
CGraphicsTransform
CHorizontalSlider
CHorizontalSwitch
CInvalidRectList
CKickButton
CKnob
```

--------------------------------

### VSTGUI Classes Overview

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/class_v_s_t_g_u_i_1_1_z_lib_input_content_provider

This section provides an overview of the classes available within the VSTGUI framework. It lists classes related to UI elements, data handling, graphics, and more, aiding in understanding the structure and components of the library.

```Documentation
Classes
  Class List
  Class Index
  Class Hierarchy
  Class Members
    All
    Functions
    Variables
    Typedefs
    Enumerations
    Enumerator
    Related Symbols
```

--------------------------------

### Get Control Listener and Size

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_g

Retrieves the control listener from DelegationController, IController, IUIDescription, or UIDescription. Also gets the private control size from CSliderBase.

```C++
getControlListener() : DelegationController, IController, IUIDescription, UIDescription
getControlSizePrivate() : CSliderBase
```

--------------------------------

### Get Control Listener and Size

Source: https://steinbergmedia.github.io/vst3_doc/vstgui/html/functions_func_g

Retrieves the control listener from DelegationController, IController, IUIDescription, or UIDescription. Also gets the private control size from CSliderBase.

```C++
getControlListener() : DelegationController, IController, IUIDescription, UIDescription
getControlSizePrivate() : CSliderBase
```
Tokens:
Raw