RVC::UI::FORM_EDIT_STYLE Class Reference

User Interface form for editing style definition. More...

#include <rvc/uistyle.h>

Inheritance diagram for RVC::UI::FORM_EDIT_STYLE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FORM_EDIT_STYLE ()
virtual ~FORM_EDIT_STYLE ()
ERRVALUE CommitChanges ()
ERRVALUE Create (MGUI::LAYOUT_PANE_BASE &ParentPane, RVC::STYLETYPE StyleType, EDITSTYLEFLAGS FormStyle=EDITSTYLEFLAG_None)
INT32 GetActiveStyleNum (RVC::STYLETYPE StyleType) const
INT32 GetActiveStyleNum () const
RVC::STYLETYPE GetActiveStyleType () const
double GetCurrentScale ()
void GetDefaultStyle (MULTISTYLE &MultiStyle) const
void GetDefaultStyle (TEXTSTYLE &TextStyle) const
void GetDefaultStyle (POLYSTYLE &PolyStyle) const
void GetDefaultStyle (LINESTYLE &LineStyle) const
void GetDefaultStyle (POINTSTYLE &PointStyle) const
void GetStyleObjItem (RVC::OBJITEM &ObjItem) const
virtual bool IsCreated () const
virtual bool IsEnabled () const
bool IsObjectModified ()
void ResetModified ()
ERRVALUE SetActiveStyleNum (RVC::STYLETYPE StyleType, INT32 StyleNum)
void SetCurrentMapScale (double CurMapScale)
void SetDefaultStyle (const MULTISTYLE &MultiStyle)
void SetDefaultStyle (const TEXTSTYLE &TextStyle)
void SetDefaultStyle (const POLYSTYLE &PolygonStyle)
void SetDefaultStyle (const POINTSTYLE &PointStyle)
void SetDefaultStyle (const LINESTYLE &LineStyle)
void SetDelegateGetCurrentScale (DELEGATE_DOUBLE_NOPARMS delegate)
void SetDelegateNotifyModified (DELEGATE_VOID_NOPARMS delegate)
virtual void SetEnabled (bool enabled=true)
void SetHardcopyDPI (double HardcopyDPI)
ERRVALUE SetStyleObject (const RVC::OBJITEM &ObjItem, RVC::OBJECT::OPENMODE OpenMode=RVC::OBJECT::OPENMODE_Read)
void SetStyleType (RVC::STYLETYPE StyleType)

Detailed Description

User Interface form for editing style definition.


Constructor & Destructor Documentation

RVC::UI::FORM_EDIT_STYLE::FORM_EDIT_STYLE (  ) 

Constructor.

virtual RVC::UI::FORM_EDIT_STYLE::~FORM_EDIT_STYLE (  )  [virtual]

Destructor.


Member Function Documentation

ERRVALUE RVC::UI::FORM_EDIT_STYLE::CommitChanges (  ) 

Commit changes made by user to file.

ERRVALUE RVC::UI::FORM_EDIT_STYLE::Create ( MGUI::LAYOUT_PANE_BASE ParentPane,
RVC::STYLETYPE  StyleType,
EDITSTYLEFLAGS  FormStyle = EDITSTYLEFLAG_None 
)

Create the form.

INT32 RVC::UI::FORM_EDIT_STYLE::GetActiveStyleNum ( RVC::STYLETYPE  StyleType  )  const

Get active style number for specified type.

Returns:
Active style number, -1 for "default" style, < -1 if error.
INT32 RVC::UI::FORM_EDIT_STYLE::GetActiveStyleNum (  )  const [inline]

Get active style number.

Returns:
Active style number, -1 for "default" style, < -1 if error.
RVC::STYLETYPE RVC::UI::FORM_EDIT_STYLE::GetActiveStyleType (  )  const [inline]

Get active style type.

double RVC::UI::FORM_EDIT_STYLE::GetCurrentScale (  ) 

Get current scale.

void RVC::UI::FORM_EDIT_STYLE::GetDefaultStyle ( MULTISTYLE MultiStyle  )  const

Get default MULTISTYLE.

void RVC::UI::FORM_EDIT_STYLE::GetDefaultStyle ( TEXTSTYLE TextStyle  )  const

Get default TEXTSTYLE.

void RVC::UI::FORM_EDIT_STYLE::GetDefaultStyle ( POLYSTYLE PolyStyle  )  const

Get default POLYSTYLE.

void RVC::UI::FORM_EDIT_STYLE::GetDefaultStyle ( LINESTYLE LineStyle  )  const

Get default LINESTYLE.

void RVC::UI::FORM_EDIT_STYLE::GetDefaultStyle ( POINTSTYLE PointStyle  )  const

Get default POINTSTYLE.

void RVC::UI::FORM_EDIT_STYLE::GetStyleObjItem ( RVC::OBJITEM ObjItem  )  const

Get current style object item.

virtual bool RVC::UI::FORM_EDIT_STYLE::IsCreated (  )  const [virtual]

Determine if form has been created.

Returns:
true if created, false if not.

Implements MGUI::FORM.

virtual bool RVC::UI::FORM_EDIT_STYLE::IsEnabled (  )  const [virtual]
bool RVC::UI::FORM_EDIT_STYLE::IsObjectModified (  )  [inline]

Determine if RVC style object has been modified by user edits.

void RVC::UI::FORM_EDIT_STYLE::ResetModified (  )  [inline]

Reset 'modified' status.

ERRVALUE RVC::UI::FORM_EDIT_STYLE::SetActiveStyleNum ( RVC::STYLETYPE  StyleType,
INT32  StyleNum 
)

Set active style number for specified style type.

This does not change the style type being "edited", use SetStyleType() to do that.

void RVC::UI::FORM_EDIT_STYLE::SetCurrentMapScale ( double  CurMapScale  )  [inline]

Set current 'map scale' for style samples and 'Current Scale' button.

void RVC::UI::FORM_EDIT_STYLE::SetDefaultStyle ( const MULTISTYLE MultiStyle  ) 

Set default MULTISTYLE style.

void RVC::UI::FORM_EDIT_STYLE::SetDefaultStyle ( const TEXTSTYLE TextStyle  ) 

Set default TEXT style.

void RVC::UI::FORM_EDIT_STYLE::SetDefaultStyle ( const POLYSTYLE PolygonStyle  ) 

Set default POLYGON style.

void RVC::UI::FORM_EDIT_STYLE::SetDefaultStyle ( const POINTSTYLE PointStyle  ) 

Set default POINT style.

void RVC::UI::FORM_EDIT_STYLE::SetDefaultStyle ( const LINESTYLE LineStyle  ) 

Set default LINE style.

void RVC::UI::FORM_EDIT_STYLE::SetDelegateGetCurrentScale ( DELEGATE_DOUBLE_NOPARMS  delegate  )  [inline]

Set delegate for obtaining current map scale.

void RVC::UI::FORM_EDIT_STYLE::SetDelegateNotifyModified ( DELEGATE_VOID_NOPARMS  delegate  )  [inline]

Set delegate to call when style edited.

virtual void RVC::UI::FORM_EDIT_STYLE::SetEnabled ( bool  enabled = true  )  [virtual]

Set whether mouse or keyboard input to form is allowed.

Implements MGUI::FORM.

void RVC::UI::FORM_EDIT_STYLE::SetHardcopyDPI ( double  HardcopyDPI  )  [inline]

Set hardcopy pixel spacing in "pixels per inch".

This value is used when user chooses units to view style elements in.

ERRVALUE RVC::UI::FORM_EDIT_STYLE::SetStyleObject ( const RVC::OBJITEM ObjItem,
RVC::OBJECT::OPENMODE  OpenMode = RVC::OBJECT::OPENMODE_Read 
)

Set style object to edit or select styles from.

void RVC::UI::FORM_EDIT_STYLE::SetStyleType ( RVC::STYLETYPE  StyleType  ) 

Set type of style being edited.


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

Generated on Sun Oct 7 21:38:57 2012 for TNTsdk 2012 by  doxygen 1.6.1