BevelProfileEditorInformation Class Reference

This class provides information on the Bevel Profile Editor to plugins which want to use the standard editor (initially implemented by TextPlus). More...

#include <BevelProfileInterface.h>

Public Member Functions
virtual HWND	GetHWND ()=0
	Returns the window handle of the Bevel Profile Editor.
virtual bool	GetZoom (float &z)=0
	Get the zoom factor of the Bevel Profile Editor.
virtual bool	GetScrolls (int &hs, int &vs)=0
	Get the horizontal and vertical scroll values of the Bevel Profile Editor.
virtual void	SetZoom (float z)=0
	Sets the zoom factor of the curve window.
virtual void	SetScrolls (int hs, int vs)=0
	Get the horizontal and vertical scroll values of the Bevel Profile Editor.
virtual void	Notify (UINT message, WPARAM wParam, LPARAM lParam)=0
	Send a message to the Bevel Profile Editor window.
virtual void	ShowWindow (HWND owningWindow, bool sw=true)=0
	Tells the Bevel Profile Editor to display or hide its window.
virtual void	CloseWindow ()=0
	Tells the Bevel Profile Editor window to close.
virtual void	DeleteMe ()=0
	Deletes the BevelProfileEditorInformation object.

Detailed Description

This class provides information on the Bevel Profile Editor to plugins which want to use the standard editor (initially implemented by TextPlus).

If you wish to use the Bevel Profile Editor, call BevelProfileInterface::GetBevelProfileEditorInformation (see below), which will return a pointer to this object, which you can use to control the editor.

All methods are implemented by the system.

Member Function Documentation

GetHWND()

virtual HWND GetHWND ( )

pure virtual

Returns the window handle of the Bevel Profile Editor.

Returns

The window handle of the Bevel Profile Editor

GetZoom()

virtual bool GetZoom ( float &  z )

pure virtual

Get the zoom factor of the Bevel Profile Editor.

Parameters

z	[out] - The zoom factor of the window if the return value is true

Returns

true if the zoom factor is valid for use; false if it is not

GetScrolls()

virtual bool GetScrolls ( int &  hs, int &  vs  )

pure virtual

Get the horizontal and vertical scroll values of the Bevel Profile Editor.

Parameters

hs	[out] - The horizontal scroll value
vs	[out] - The vertical scroll value

Returns

true if the scroll values are valid for use; false if they are not

SetZoom()

virtual void SetZoom ( float  z )

pure virtual

Sets the zoom factor of the curve window.

Parameters

z	- The zoom factor

SetScrolls()

virtual void SetScrolls ( int  hs, int  vs  )

pure virtual

Get the horizontal and vertical scroll values of the Bevel Profile Editor.

Parameters

hs	- The horizontal scroll value
vs	- The vertical scroll value

Notify()

virtual void Notify ( UINT  message, WPARAM  wParam, LPARAM  lParam  )

pure virtual

Send a message to the Bevel Profile Editor window.

Parameters

message	- The message to send
wParam	- Additional message-specific parameter
lParam	- Additional message-specific parameter

ShowWindow()

virtual void ShowWindow ( HWND  owningWindow, bool  sw = true  )

pure virtual

Tells the Bevel Profile Editor to display or hide its window.

Parameters

owningWindow	- The handle of the window that owns the editor. This is usually the plugin's parameter rollup window.
sw	- If true, displays the editor window. If false, hides it.

CloseWindow()

virtual void CloseWindow ( )

pure virtual

Tells the Bevel Profile Editor window to close.

DeleteMe()

virtual void DeleteMe ( )

pure virtual

Deletes the BevelProfileEditorInformation object.