[−][src]Enum reaper_medium::RegistrationObject
A thing that you can register at REAPER.
Variants
HookCommand(HookCommandFn)
A hook command.
Extract from reaper_plugin_functions.h
:
another thing you can register is "hookcommand", which you pass a callback: NON_API: bool runCommand(int command, int flag); register("hookcommand",runCommand); which returns TRUE to eat (process) the command. flag is usually 0 but can sometimes have useful info depending on the message. note: it's OK to call Main_OnCommand() within your runCommand, however you MUST check for recursion if doing so! > in fact, any use of this hook should benefit from a simple reentrancy test...
HookPostCommand(HookPostCommandFn)
A hook post command.
Extract from reaper_plugin_functions.h
:
to get notified when an action of the main section is performed, you can register "hookpostcommand", which you pass a callback: NON_API: void postCommand(int command, int flag); register("hookpostcommand",postCommand);
ToggleAction(ToggleActionFn)
A toggle action.
Extract from reaper_plugin.h
:
register("toggleaction", toggleactioncallback) lets you register a callback function that is called to check if an action registered by an extension has an on/off state. callback function: int toggleactioncallback(int command_id); return: -1=action does not belong to this extension, or does not toggle 0=action belongs to this extension and is currently set to "off" 1=action belongs to this extension and is currently set to "on"
A command ID for the given command name.
Extract from reaper_plugin_functions.h
:
you can also register command IDs for actions, register with "command_id", parameter is a unique string with only A-Z, 0-9, returns command ID (or 0 if not supported/out of actions)
Gaccel(NonNull<gaccel_register_t>)
An action description and shortcut.
Extract from reaper_plugin.h
:
gaccel_register_t allows you to register ("gaccel") an action into the main keyboard section action list, and at the same time a default binding for it (accel.cmd is the command ID, desc is the description, and accel's other parameters are the key to bind.
CsurfInst(NonNull<IReaperControlSurface>)
A hidden control surface (useful for being notified by REAPER about events).
Extract from reaper_plugin.h
:
note you can also add a control surface behind the scenes with "csurf_inst" (IReaperControlSurface*)instance
If a variant is missing in this enum, you can use this custom one as a resort.
Use custom()
to create this variant.
Implementations
impl<'a> RegistrationObject<'a>
[src]
pub fn custom(
key: impl Into<ReaperStringArg<'a>>,
info_struct: *mut c_void
) -> RegistrationObject<'a>
[src]
key: impl Into<ReaperStringArg<'a>>,
info_struct: *mut c_void
) -> RegistrationObject<'a>
Convenience function for creating a Custom
registration object.
Trait Implementations
impl<'a> Clone for RegistrationObject<'a>
[src]
fn clone(&self) -> RegistrationObject<'a>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Debug for RegistrationObject<'a>
[src]
impl<'a> Eq for RegistrationObject<'a>
[src]
impl<'a> Hash for RegistrationObject<'a>
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<'a> PartialEq<RegistrationObject<'a>> for RegistrationObject<'a>
[src]
fn eq(&self, other: &RegistrationObject<'a>) -> bool
[src]
fn ne(&self, other: &RegistrationObject<'a>) -> bool
[src]
impl<'a> StructuralEq for RegistrationObject<'a>
[src]
impl<'a> StructuralPartialEq for RegistrationObject<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for RegistrationObject<'a>
impl<'a> !Send for RegistrationObject<'a>
impl<'a> !Sync for RegistrationObject<'a>
impl<'a> Unpin for RegistrationObject<'a>
impl<'a> UnwindSafe for RegistrationObject<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,