Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::sound::au::AudioUnitView Class Reference

A class that wraps Audio Unit plugin editor views in a generic interface. More...

#include <omSoundAudioUnitView.h>

Inheritance diagram for om::sound::au::AudioUnitView:

Public Member Functions

 AudioUnitView (AudioUnitHost *host)
 Create a new audio unit view for the specified audio unit host object. More...
 
virtual UTF8String getName () const
 Return a human-readable name for this audio unit view. More...
 
virtual UTF8String getManufacturer () const
 Return a human-readable name for this audio unit view view's manufacturer. More...
 
virtual FilterVersion getVersion () const
 Return an object representing the version of this audio unit view. More...
 
virtual gui::ViewgetGUIView () const
 Return a pointer to an object that represents the visual appearance of this audio unit view. More...
 
virtual SoundFiltergetFilter () const
 Return a pointer to the sound filter which this filter view is wrapping. More...
 
virtual void open ()
 Indicate to the audio unit view that it is becoming visible and so should start drawing itself. More...
 
virtual void close ()
 Indicate to the audio unit view that it is becoming no longer visible and so should stop drawing itself. More...
 
virtual Bool keyEvent (const views::KeyEvent &event)
 Handle the specified keyboard event that occured for the audio unit view. More...
 
virtual Bool mouseMotionEvent (const views::MouseMotionEvent &event)
 Handle the specified mouse motion event that occurred for the audio unit view. More...
 
virtual Bool mouseButtonEvent (const views::MouseButtonEvent &event)
 Handle the specified mouse button event that occurred for the audio unit view. More...
 
virtual Bool mouseWheelEvent (const views::MouseWheelEvent &event)
 Handle the specified mouse wheel event that occurred for the audio unit view. More...
 

Detailed Description

A class that wraps Audio Unit plugin editor views in a generic interface.

Constructor & Destructor Documentation

om::sound::au::AudioUnitView::AudioUnitView ( AudioUnitHost host)

Create a new audio unit view for the specified audio unit host object.

Member Function Documentation

virtual UTF8String om::sound::au::AudioUnitView::getName ( ) const
virtual

Return a human-readable name for this audio unit view.

virtual UTF8String om::sound::au::AudioUnitView::getManufacturer ( ) const
virtual

Return a human-readable name for this audio unit view view's manufacturer.

virtual FilterVersion om::sound::au::AudioUnitView::getVersion ( ) const
virtual

Return an object representing the version of this audio unit view.

virtual gui::View* om::sound::au::AudioUnitView::getGUIView ( ) const
virtual

Return a pointer to an object that represents the visual appearance of this audio unit view.

virtual SoundFilter* om::sound::au::AudioUnitView::getFilter ( ) const
virtual

Return a pointer to the sound filter which this filter view is wrapping.

virtual void om::sound::au::AudioUnitView::open ( )
virtual

Indicate to the audio unit view that it is becoming visible and so should start drawing itself.

virtual void om::sound::au::AudioUnitView::close ( )
virtual

Indicate to the audio unit view that it is becoming no longer visible and so should stop drawing itself.

virtual Bool om::sound::au::AudioUnitView::keyEvent ( const views::KeyEvent &  event)
virtual

Handle the specified keyboard event that occured for the audio unit view.

virtual Bool om::sound::au::AudioUnitView::mouseMotionEvent ( const views::MouseMotionEvent &  event)
virtual

Handle the specified mouse motion event that occurred for the audio unit view.

virtual Bool om::sound::au::AudioUnitView::mouseButtonEvent ( const views::MouseButtonEvent &  event)
virtual

Handle the specified mouse button event that occurred for the audio unit view.

virtual Bool om::sound::au::AudioUnitView::mouseWheelEvent ( const views::MouseWheelEvent &  event)
virtual

Handle the specified mouse wheel event that occurred for the audio unit view.


The documentation for this class was generated from the following file: