Reaper extension base class interface. More...

#include <ReaperExtBase.h>

Inheritance diagram for ReaperExtBase:

Public Member Functions
	ReaperExtBase (reaper_plugin_info_t *pRec)

void	BeginInformHostOfParamChangeFromUI (int paramIdx) override

void	EndInformHostOfParamChangeFromUI (int paramIdx) override

bool	EditorResizeFromUI (int viewWidth, int viewHeight, bool needsPlatformResize) override

virtual void	OnIdle ()
	Called during idle processing - override to perform periodic tasks. More...

void	RegisterAction (const char actionName, std::function< void()> func, bool addMenuItem=false, int pToggle=nullptr)
	Registers an action with the REAPER extension system. More...

void	ShowHideMainWindow ()
	Toggles the visibility of the main extension window. More...

void	ToggleDocking ()
	Toggles between docked and floating state. More...

bool	IsDocked () const
	Returns true if the window is currently docked. More...

void	SetDockId (const char *id)
	Sets the unique identifier used for dock state persistence. More...

Static Public Member Functions
static bool	HookCommandProc (int command, int flag)

static int	ToggleActionCallback (int command)

Detailed Description

Reaper extension base class interface.

Definition at line 38 of file ReaperExtBase.h.

Constructor & Destructor Documentation

◆ ReaperExtBase()

ReaperExtBase::ReaperExtBase ( reaper_plugin_info_t * pRec )

Definition at line 5 of file ReaperExtBase.cpp.

◆ ~ReaperExtBase()

ReaperExtBase::~ReaperExtBase ( )

virtual

Definition at line 15 of file ReaperExtBase.cpp.

Member Function Documentation

◆ BeginInformHostOfParamChangeFromUI()

void ReaperExtBase::BeginInformHostOfParamChangeFromUI ( int paramIdx )

inlineoverride

Definition at line 46 of file ReaperExtBase.h.

◆ EditorResizeFromUI()

bool ReaperExtBase::EditorResizeFromUI	(	int	viewWidth,
		int	viewHeight,
		bool	needsPlatformResize
	)

override

Definition at line 49 of file ReaperExtBase.cpp.

◆ EndInformHostOfParamChangeFromUI()

void ReaperExtBase::EndInformHostOfParamChangeFromUI ( int paramIdx )

inlineoverride

Definition at line 48 of file ReaperExtBase.h.

◆ HookCommandProc()

bool ReaperExtBase::HookCommandProc	(	int	command,
		int	flag
	)

static

Definition at line 203 of file ReaperExtBase.cpp.

◆ IsDocked()

bool ReaperExtBase::IsDocked ( ) const

inline

Returns true if the window is currently docked.

Definition at line 69 of file ReaperExtBase.h.

Referenced by ShowHideMainWindow(), and ToggleDocking().

◆ OnIdle()

virtual void ReaperExtBase::OnIdle ( )

inlinevirtual

Called during idle processing - override to perform periodic tasks.

Definition at line 53 of file ReaperExtBase.h.

◆ RegisterAction()

void ReaperExtBase::RegisterAction	(	const char *	actionName,
		std::function< void()>	func,
		bool	addMenuItem = `false`,
		int *	pToggle = `nullptr`
	)

Registers an action with the REAPER extension system.

Parameters

actionName	The name of the action to register
func	The function to call when the action is executed
addMenuItem	If true, adds a menu item for this action
pToggle	Optional pointer to an int for toggle state

Definition at line 183 of file ReaperExtBase.cpp.

◆ SetDockId()

void ReaperExtBase::SetDockId ( const char * id )

inline

Sets the unique identifier used for dock state persistence.

Parameters

id	Unique identifier string (defaults to PLUG_CLASS_NAME)

Definition at line 73 of file ReaperExtBase.h.

◆ ShowHideMainWindow()

void ReaperExtBase::ShowHideMainWindow ( )

Toggles the visibility of the main extension window.

Definition at line 97 of file ReaperExtBase.cpp.

References IsDocked().

◆ ToggleActionCallback()

int ReaperExtBase::ToggleActionCallback ( int command )

static

Definition at line 216 of file ReaperExtBase.cpp.

◆ ToggleDocking()

void ReaperExtBase::ToggleDocking ( )

Toggles between docked and floating state.

Definition at line 111 of file ReaperExtBase.cpp.