Steinberg::IPlugView Class Reference

#include <iplugview.h>

Inheritance diagram for Steinberg::IPlugView:

Steinberg::FUnknown List of all members.

Public Member Functions

virtual tresult PLUGIN_API isPlatformTypeSupported (FIDString type)=0
virtual tresult PLUGIN_API attached (void *parent, FIDString type)=0
virtual tresult PLUGIN_API removed ()=0
virtual tresult PLUGIN_API onWheel (float distance)=0
virtual tresult PLUGIN_API onKeyDown (char16 key, int16 keyCode, int16 modifiers)=0
virtual tresult PLUGIN_API onKeyUp (char16 key, int16 keyCode, int16 modifiers)=0
virtual tresult PLUGIN_API getSize (ViewRect *size)=0
virtual tresult PLUGIN_API onSize (ViewRect *newSize)=0
virtual tresult PLUGIN_API onFocus (TBool state)=0
virtual tresult PLUGIN_API setFrame (IPlugFrame *frame)=0
virtual tresult PLUGIN_API canResize ()=0
virtual tresult PLUGIN_API checkSizeConstraint (ViewRect *rect)=0

Static Public Attributes

static const FUID iid

Detailed Description

Plug-in definition of a view. [plug imp]

Definition at line 85 of file iplugview.h.


Member Function Documentation

virtual tresult PLUGIN_API Steinberg::IPlugView::attached ( void *  parent,
FIDString  type 
) [pure virtual]

The parent window of the view has been created, the (platform) representation of the view should now be created as well.

Parameters:
parent : platform handle of the parent window or view
type : Platform UI Type which should be created

virtual tresult PLUGIN_API Steinberg::IPlugView::canResize (  )  [pure virtual]

Is view sizable by user.

virtual tresult PLUGIN_API Steinberg::IPlugView::checkSizeConstraint ( ViewRect rect  )  [pure virtual]

On live resize this is called to check if the view can be resized to the given rect, if not adjust the rect to the allowed size.

virtual tresult PLUGIN_API Steinberg::IPlugView::getSize ( ViewRect size  )  [pure virtual]

return the size of the platform representation of the view.

virtual tresult PLUGIN_API Steinberg::IPlugView::isPlatformTypeSupported ( FIDString  type  )  [pure virtual]

Is Platform UI Type supported

Parameters:
type : IDString of Platform UI Type

virtual tresult PLUGIN_API Steinberg::IPlugView::onFocus ( TBool  state  )  [pure virtual]

Focus changed message.

virtual tresult PLUGIN_API Steinberg::IPlugView::onKeyDown ( char16  key,
int16  keyCode,
int16  modifiers 
) [pure virtual]

Handling of keyboard events : Key Down.

Parameters:
key : unicode code of key
keyCode : virtual keycode for non ascii keys -
See also:
VirtualKeyCodes in keycodes.h
Parameters:
modifiers : any combination of KeyModifier -
See also:
keycodes.h

virtual tresult PLUGIN_API Steinberg::IPlugView::onKeyUp ( char16  key,
int16  keyCode,
int16  modifiers 
) [pure virtual]

Handling of keyboard events : Key Up.

Parameters:
key : unicode code of key
keyCode : virtual keycode for non ascii keys -
See also:
VirtualKeyCodes in keycodes.h
Parameters:
modifiers : any combination of KeyModifier -
See also:
keycodes.h

virtual tresult PLUGIN_API Steinberg::IPlugView::onSize ( ViewRect newSize  )  [pure virtual]

Resize the platform representation of the view to the given rect.

virtual tresult PLUGIN_API Steinberg::IPlugView::onWheel ( float  distance  )  [pure virtual]

Handling of mouse wheel.

virtual tresult PLUGIN_API Steinberg::IPlugView::removed (  )  [pure virtual]

The parent window of the view is about to be destroyed.

virtual tresult PLUGIN_API Steinberg::IPlugView::setFrame ( IPlugFrame frame  )  [pure virtual]

Sets IPlugFrame object to allow the plug-in to inform the host about resizing.


Member Data Documentation

const FUID Steinberg::IPlugView::iid [static]

Reimplemented from Steinberg::FUnknown.

Definition at line 135 of file iplugview.h.


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

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.