MGUI::TOOL_TEXT Class Reference

Text graphic tool. More...

#include <mgui/tooltext.h>

Inheritance diagram for MGUI::TOOL_TEXT:

[legend]

List of all members.

Classes
class	LEADER
Public Types
enum	BASECURVE { BASECURVE_Straight, BASECURVE_Exact, BASECURVE_Spline }
enum	EDITMODE {   EDITMODE_Automatic, EDITMODE_AddEnd, EDITMODE_AddStart, EDITMODE_InsertVertex,   EDITMODE_DragVertex, EDITMODE_DeleteVertex, EDITMODE_Move }
typedef MILIST< LEADER >	LEADERLIST
enum	TOOLSTYLE {   TOOLSTYLE_Default = 0x0000, TOOLSTYLE_NoEditBaseLine = 0x0001, TOOLSTYLE_NoLeaderLines = 0x0002, TOOLSTYLE_NoStyleControls = 0x0004,   TOOLSTYLE_NoStyleAdvanced = 0x0008, TOOLSTYLE_ControlFormEditHeight = 0x0010 }
Public Member Functions
	TOOL_TEXT (TOOLCANVAS *canvas)
virtual	~TOOL_TEXT ()
void	ClearLeaderList ()
void	ClearSourceLine ()
void	ClearString ()
BASECURVE	GetBaseCurve () const
const POLYLINE &	GetBaseLine () const
EDITMODE	GetEditMode () const
double	GetHeight () const
const LEADERLIST &	GetLeaderList () const
const MISTRING &	GetText () const
const TEXTSTYLE &	GetTextStyle () const
TOOLSTYLE	GetToolStyle () const
void	LeaderLineAdd (const LEADER &Leader)
void	LeaderLineAdd ()
void	LeaderLineRemoveActive ()
void	ReverseBaseLine ()
void	SetActiveNext ()
void	SetActivePrevious ()
void	SetBaseCurve (BASECURVE BaseCurve)
void	SetBaseLine (const POLYLINE &BaseLine, BASECURVE BaseCurve)
void	SetCaretPos (INT32 row, INT32 column)
void	SetEditMode (EDITMODE EditMode)
void	SetHeight (double height)
void	SetLeaderList (const LEADERLIST &LeaderList)
void	SetMapScale (double MapScale)
void	SetSourceLine (const POLYLINE &SourceLine)
void	SetText (const MISTRING &text)
void	SetTextStyle (const TEXTSTYLE &TextStyle)
void	SetToolStyle (TOOLSTYLE ToolStyle)

---

Detailed Description

Text graphic tool.

---

Member Typedef Documentation

typedef MILIST<LEADER> MGUI::TOOL_TEXT::LEADERLIST

---

Member Enumeration Documentation

enum MGUI::TOOL_TEXT::BASECURVE

Enumerator:

BASECURVE_Straight
BASECURVE_Exact
BASECURVE_Spline

enum MGUI::TOOL_TEXT::EDITMODE

Enumerator:

EDITMODE_Automatic
EDITMODE_AddEnd	Add vertices to end of active line (default).
EDITMODE_AddStart	Add vertices to start of active line.
EDITMODE_InsertVertex	Insert vertex.
EDITMODE_DragVertex	Drag nearest vertex.
EDITMODE_DeleteVertex	Delete nearest vertex.
EDITMODE_Move	Move active line.

enum MGUI::TOOL_TEXT::TOOLSTYLE

Enumerator:

TOOLSTYLE_Default
TOOLSTYLE_NoEditBaseLine	Don't allow editing of baseline or leaders.
TOOLSTYLE_NoLeaderLines	Don't allow creation/editing of leader lines.
TOOLSTYLE_NoStyleControls	Don't include style controls.
TOOLSTYLE_NoStyleAdvanced	Don't include "advanced" style button.
TOOLSTYLE_ControlFormEditHeight	Include "height" editing in "control form".

---

Constructor & Destructor Documentation

MGUI::TOOL_TEXT::TOOL_TEXT

(

TOOLCANVAS *

canvas

)

[explicit]

Constructor.

Parameters:

canvas

View to contain tool

virtual MGUI::TOOL_TEXT::~TOOL_TEXT

(

)

[virtual]

Destructor.

---

Member Function Documentation

void MGUI::TOOL_TEXT::ClearLeaderList

(

)

Clear leader list without clearing baseline or string.

void MGUI::TOOL_TEXT::ClearSourceLine

(

)

Clear source line without clearing baseline, string or leaders.

The source line is the line to follow if text is to be moved "along" the line

void MGUI::TOOL_TEXT::ClearString

(

)

Clear string without clearing baseline or leaders.

BASECURVE MGUI::TOOL_TEXT::GetBaseCurve

(

)

const [inline]

Get base curvature.

const POLYLINE& MGUI::TOOL_TEXT::GetBaseLine

(

)

const [inline]

Get base line.

EDITMODE MGUI::TOOL_TEXT::GetEditMode

(

)

const [inline]

Get line editing mode.

double MGUI::TOOL_TEXT::GetHeight

(

)

const [inline]

Get height in tool units.

const LEADERLIST& MGUI::TOOL_TEXT::GetLeaderList

(

)

const [inline]

Get list of leader lines.

const MISTRING& MGUI::TOOL_TEXT::GetText

(

)

const [inline]

Get text string.

const TEXTSTYLE& MGUI::TOOL_TEXT::GetTextStyle

(

)

const [inline]

Get text style.

TOOLSTYLE MGUI::TOOL_TEXT::GetToolStyle

(

)

const [inline]

Get tool style.

void MGUI::TOOL_TEXT::LeaderLineAdd

(

const LEADER &

Leader

)

Add new leader line and make it "active".

void MGUI::TOOL_TEXT::LeaderLineAdd

(

)

Add new leader line and make it "active".

void MGUI::TOOL_TEXT::LeaderLineRemoveActive

(

)

Remove active leader line.

void MGUI::TOOL_TEXT::ReverseBaseLine

(

)

Reverse order of baseline points.

void MGUI::TOOL_TEXT::SetActiveNext

(

)

Set active "line" to next.

void MGUI::TOOL_TEXT::SetActivePrevious

(

)

Set active "line" to previous.

void MGUI::TOOL_TEXT::SetBaseCurve

(

BASECURVE

BaseCurve

)

Set base curvature.

void MGUI::TOOL_TEXT::SetBaseLine	(	const POLYLINE &	BaseLine,
		BASECURVE	BaseCurve
	)

Set base line.

void MGUI::TOOL_TEXT::SetCaretPos	(	INT32	row,
		INT32	column
	)

Set caret position.

void MGUI::TOOL_TEXT::SetEditMode

(

EDITMODE

EditMode

)

[inline]

Set line editing mode.

Parameters:

EditMode

New editing mode

void MGUI::TOOL_TEXT::SetHeight

(

double

height

)

Set height in tool units.

void MGUI::TOOL_TEXT::SetLeaderList

(

const LEADERLIST &

LeaderList

)

Set list of leader lines.

void MGUI::TOOL_TEXT::SetMapScale

(

double

MapScale

)

Set map scale for height computation.

void MGUI::TOOL_TEXT::SetSourceLine

(

const POLYLINE &

SourceLine

)

Set source line The source line is the line to follow if text is to be moved "along" the line.

void MGUI::TOOL_TEXT::SetText

(

const MISTRING &

text

)

Set text string.

void MGUI::TOOL_TEXT::SetTextStyle

(

const TEXTSTYLE &

TextStyle

)

Set text style.

void MGUI::TOOL_TEXT::SetToolStyle

(

TOOLSTYLE

ToolStyle

)

[inline]

Set tool style.

---

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

• mgui/tooltext.h