Plug-in definition of a view. More...
#include <iplugview.h>
Public Member Functions | |
virtual tresult | isPlatformTypeSupported (FIDString type)=0 |
Is Platform UI Type supported. | |
virtual tresult | attached (void *parent, FIDString type)=0 |
The parent window of the view has been created, the (platform) representation of the view should now be created as well. | |
virtual tresult | removed ()=0 |
The parent window of the view is about to be destroyed. | |
virtual tresult | onWheel (float distance)=0 |
Handling of mouse wheel. | |
virtual tresult | onKeyDown (char16 key, int16 keyCode, int16 modifiers)=0 |
Handling of keyboard events : Key Down. | |
virtual tresult | onKeyUp (char16 key, int16 keyCode, int16 modifiers)=0 |
Handling of keyboard events : Key Up. | |
virtual tresult | getSize (ViewRect *size)=0 |
Returns the size of the platform representation of the view. | |
virtual tresult | onSize (ViewRect *newSize)=0 |
Resizes the platform representation of the view to the given rect. | |
virtual tresult | onFocus (TBool state)=0 |
Focus changed message. | |
virtual tresult | setFrame (IPlugFrame *frame)=0 |
Sets IPlugFrame object to allow the Plug-in to inform the host about resizing. | |
virtual tresult | canResize ()=0 |
Is view sizable by user. | |
virtual tresult | checkSizeConstraint (ViewRect *rect)=0 |
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. | |
Static Public Attributes | |
static const FUID | iid |
Plug-in definition of a view.
Is Platform UI Type supported.
type | : IDString of Platform UI Types |
The parent window of the view has been created, the (platform) representation of the view should now be created as well.
Note that the parent is owned by the caller and you are not allowed to alter it in any way other than adding your own views.
parent | : platform handle of the parent window or view | |
type | : Platform UI Types which should be created |
virtual tresult removed | ( | ) | [pure virtual] |
The parent window of the view is about to be destroyed.
You have to remove all your own views from the parent window or view.
virtual tresult onWheel | ( | float | distance | ) | [pure virtual] |
Handling of mouse wheel.
Handling of keyboard events : Key Down.
key | : unicode code of key | |
keyCode | : virtual keycode for non ascii keys - see VirtualKeyCodes in keycodes.h | |
modifiers | : any combination of modifiers - see KeyModifier in keycodes.h |
Handling of keyboard events : Key Up.
key | : unicode code of key | |
keyCode | : virtual keycode for non ascii keys - see VirtualKeyCodes in keycodes.h | |
modifiers | : any combination of KeyModifier - see KeyModifier in keycodes.h |
Returns the size of the platform representation of the view.
Resizes the platform representation of the view to the given rect.
virtual tresult setFrame | ( | IPlugFrame * | frame | ) | [pure virtual] |
Sets IPlugFrame object to allow the Plug-in to inform the host about resizing.
virtual tresult canResize | ( | ) | [pure virtual] |
Is view sizable by user.
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.