VCV Rack API v2
Loading...
Searching...
No Matches
rack::widget Namespace Reference

Base UI widget types. More...

Classes

struct  BaseEvent
 Base class for all events. More...
 
struct  EventContext
 A per-event state shared and writable by all widgets that recursively handle an event. More...
 
struct  EventState
 
struct  FramebufferWidget
 Caches its children's draw() result to a framebuffer image. More...
 
struct  OpaqueWidget
 A Widget that stops propagation of all recursive PositionEvents (such as ButtonEvent) but gives a chance for children to consume first. More...
 
struct  OpenGlWidget
 A FramebufferWidget that can be drawn on with OpenGL commands. More...
 
struct  SvgWidget
 Owns and draws a window::Svg. More...
 
struct  TransformWidget
 Transforms appearance only, not positions of events. More...
 
struct  TransparentWidget
 A Widget that does not respond to events and does not pass events to children. More...
 
struct  Widget
 A node in the 2D scene graph. More...
 
struct  ZoomWidget
 Resizes the scale of appearance and PositionEvents of children. More...
 

Functions

std::string getKeyName (int key)
 Returns the name of a GLFW key macro.
 
std::string getKeyCommandName (int key, int mods=0)
 Returns the name of a key command/chord/combo.
 

Variables

DEPRECATED typedef SvgWidget SVGWidget
 

Detailed Description

Base UI widget types.

Function Documentation

◆ getKeyName()

std::string rack::widget::getKeyName ( int key)

Returns the name of a GLFW key macro.

Printable keys return the key string such as "Q", "=", "\t", etc. Letters are capitalized. Does not remap keys based on keyboard layout, so GLFW_KEY_Q always returns "Q". GLFW_KEY_SPACE returns "Space" translated to the current language. Non-printable characters return the name of the key in the current language. Key 0 returns "".

◆ getKeyCommandName()

std::string rack::widget::getKeyCommandName ( int key,
int mods = 0 )

Returns the name of a key command/chord/combo.

For example, getKeyCommandName(GLFW_KEY_Q, GLFW_MOD_CONTROL) == "Ctrl+Q" translated to the current language.

Variable Documentation

◆ SVGWidget

DEPRECATED typedef SvgWidget rack::widget::SVGWidget