CFx SDK Documentation  2023 SP0
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdTrVisVisualStyleProperty Class Reference

#include <TrVisVisualStyle.h>

Classes

struct  DataType
 
union  TypeData
 

Public Types

enum  ColorType { kColorNone = 0 , kColorForeground = 1 , kColorBackground = 2 , kColorRGB = 255 }
 

Public Member Functions

 OdTrVisVisualStyleProperty ()
 
 OdTrVisVisualStyleProperty (const OdTrVisVisualStyleProperty &from)
 
 ~OdTrVisVisualStyleProperty ()
 
OdTrVisVisualStylePropertyoperator= (const OdTrVisVisualStyleProperty &from)
 
void setPropertyNumber (OdUInt32 propNum)
 
OdUInt32 propertyNumber () const
 
OdGiVariant::VariantType type () const
 
void set (bool bVal, bool bSet=true)
 
void set (OdInt32 iVal, bool bSet=true)
 
void set (OdUInt32 uVal, bool bSet=true, bool bAsColor=false)
 
void set (ODCOLORREF cVal, ColorType type, bool bSet=true)
 
void set (double dVal, bool bSet=true)
 
void set (const OdChar *sVal, bool bSet=true)
 
void set (const OdString &sVal, bool bSet=true)
 
void set (const char *sVal, bool bSet=true)
 
bool getBool () const
 
OdUInt8 getBoolAsInt () const
 
OdInt32 getInt () const
 
OdUInt32 getUInt () const
 
ODCOLORREF getColor (ColorType *pType=NULL) const
 
ColorType getColorType () const
 
double getDouble () const
 
const OdChargetString () const
 
void setOperation (bool bSet)
 
bool operation () const
 
void setFlag (OdUInt32 nFlag, bool bSet)
 
bool getFlag (OdUInt32 nFlag) const
 
void setModified (bool bSet)
 
bool isModified () const
 
void copyFrom (const OdTrVisVisualStyleProperty &from, bool bSet=true)
 
void reset ()
 
bool compare (const OdTrVisVisualStyleProperty &with, bool bCmpVal=true, bool bCmpOp=false, bool bCmpNum=false) const
 
bool operator== (const OdTrVisVisualStyleProperty &with) const
 
bool operator!= (const OdTrVisVisualStyleProperty &with) const
 

Protected Member Functions

void blockExecution () const
 
bool isValidType (OdGiVariant::VariantType type) const
 
bool hasString () const
 
void resetString ()
 
void setType (OdGiVariant::VariantType type)
 
void checkType (const OdGiVariant::VariantType *pTypes, OdUInt32 nTypes) const
 
void checkType (OdGiVariant::VariantType type) const
 

Protected Attributes

struct OdTrVisVisualStyleProperty::DataType m_type
 
union OdTrVisVisualStyleProperty::TypeData m_data
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 38 of file TrVisVisualStyle.h.

Member Enumeration Documentation

◆ ColorType

Enumerator
kColorNone 
kColorForeground 
kColorBackground 
kColorRGB 

Definition at line 139 of file TrVisVisualStyle.h.

Constructor & Destructor Documentation

◆ OdTrVisVisualStyleProperty() [1/2]

OdTrVisVisualStyleProperty::OdTrVisVisualStyleProperty ( )
inline

Definition at line 177 of file TrVisVisualStyle.h.

◆ OdTrVisVisualStyleProperty() [2/2]

OdTrVisVisualStyleProperty::OdTrVisVisualStyleProperty ( const OdTrVisVisualStyleProperty from)
inline

Definition at line 178 of file TrVisVisualStyle.h.

◆ ~OdTrVisVisualStyleProperty()

OdTrVisVisualStyleProperty::~OdTrVisVisualStyleProperty ( )
inline

Definition at line 179 of file TrVisVisualStyle.h.

Member Function Documentation

◆ blockExecution()

void OdTrVisVisualStyleProperty::blockExecution ( ) const
inlineprotected

Definition at line 148 of file TrVisVisualStyle.h.

◆ checkType() [1/2]

void OdTrVisVisualStyleProperty::checkType ( const OdGiVariant::VariantType pTypes,
OdUInt32  nTypes 
) const
inlineprotected

Definition at line 164 of file TrVisVisualStyle.h.

◆ checkType() [2/2]

void OdTrVisVisualStyleProperty::checkType ( OdGiVariant::VariantType  type) const
inlineprotected

Definition at line 175 of file TrVisVisualStyle.h.

◆ compare()

bool OdTrVisVisualStyleProperty::compare ( const OdTrVisVisualStyleProperty with,
bool  bCmpVal = true,
bool  bCmpOp = false,
bool  bCmpNum = false 
) const
inline

Definition at line 311 of file TrVisVisualStyle.h.

◆ copyFrom()

void OdTrVisVisualStyleProperty::copyFrom ( const OdTrVisVisualStyleProperty from,
bool  bSet = true 
)
inline

Definition at line 284 of file TrVisVisualStyle.h.

◆ getBool()

bool OdTrVisVisualStyleProperty::getBool ( ) const
inline

Definition at line 229 of file TrVisVisualStyle.h.

◆ getBoolAsInt()

OdUInt8 OdTrVisVisualStyleProperty::getBoolAsInt ( ) const
inline

Definition at line 234 of file TrVisVisualStyle.h.

◆ getColor()

ODCOLORREF OdTrVisVisualStyleProperty::getColor ( ColorType pType = NULL) const
inline

Definition at line 246 of file TrVisVisualStyle.h.

◆ getColorType()

ColorType OdTrVisVisualStyleProperty::getColorType ( ) const
inline

Definition at line 252 of file TrVisVisualStyle.h.

◆ getDouble()

double OdTrVisVisualStyleProperty::getDouble ( ) const
inline

Definition at line 257 of file TrVisVisualStyle.h.

◆ getFlag()

bool OdTrVisVisualStyleProperty::getFlag ( OdUInt32  nFlag) const
inline

Definition at line 278 of file TrVisVisualStyle.h.

◆ getInt()

OdInt32 OdTrVisVisualStyleProperty::getInt ( ) const
inline

Definition at line 235 of file TrVisVisualStyle.h.

◆ getString()

const OdChar* OdTrVisVisualStyleProperty::getString ( ) const
inline

Definition at line 262 of file TrVisVisualStyle.h.

◆ getUInt()

OdUInt32 OdTrVisVisualStyleProperty::getUInt ( ) const
inline

Definition at line 240 of file TrVisVisualStyle.h.

◆ hasString()

bool OdTrVisVisualStyleProperty::hasString ( ) const
inlineprotected

Definition at line 150 of file TrVisVisualStyle.h.

◆ isModified()

bool OdTrVisVisualStyleProperty::isModified ( ) const
inline

Definition at line 282 of file TrVisVisualStyle.h.

◆ isValidType()

bool OdTrVisVisualStyleProperty::isValidType ( OdGiVariant::VariantType  type) const
inlineprotected

Definition at line 149 of file TrVisVisualStyle.h.

◆ operation()

bool OdTrVisVisualStyleProperty::operation ( ) const
inline

Definition at line 269 of file TrVisVisualStyle.h.

◆ operator!=()

bool OdTrVisVisualStyleProperty::operator!= ( const OdTrVisVisualStyleProperty with) const
inline

Definition at line 333 of file TrVisVisualStyle.h.

◆ operator=()

OdTrVisVisualStyleProperty& OdTrVisVisualStyleProperty::operator= ( const OdTrVisVisualStyleProperty from)
inline

Definition at line 181 of file TrVisVisualStyle.h.

◆ operator==()

bool OdTrVisVisualStyleProperty::operator== ( const OdTrVisVisualStyleProperty with) const
inline

Definition at line 332 of file TrVisVisualStyle.h.

◆ propertyNumber()

OdUInt32 OdTrVisVisualStyleProperty::propertyNumber ( ) const
inline

Definition at line 185 of file TrVisVisualStyle.h.

◆ reset()

void OdTrVisVisualStyleProperty::reset ( )
inline

Definition at line 301 of file TrVisVisualStyle.h.

◆ resetString()

void OdTrVisVisualStyleProperty::resetString ( )
inlineprotected

Definition at line 151 of file TrVisVisualStyle.h.

◆ set() [1/8]

void OdTrVisVisualStyleProperty::set ( bool  bVal,
bool  bSet = true 
)
inline

Definition at line 189 of file TrVisVisualStyle.h.

◆ set() [2/8]

void OdTrVisVisualStyleProperty::set ( const char *  sVal,
bool  bSet = true 
)
inline

Definition at line 227 of file TrVisVisualStyle.h.

◆ set() [3/8]

void OdTrVisVisualStyleProperty::set ( const OdChar sVal,
bool  bSet = true 
)
inline

Definition at line 219 of file TrVisVisualStyle.h.

◆ set() [4/8]

void OdTrVisVisualStyleProperty::set ( const OdString sVal,
bool  bSet = true 
)
inline

Definition at line 226 of file TrVisVisualStyle.h.

◆ set() [5/8]

void OdTrVisVisualStyleProperty::set ( double  dVal,
bool  bSet = true 
)
inline

Definition at line 213 of file TrVisVisualStyle.h.

◆ set() [6/8]

void OdTrVisVisualStyleProperty::set ( ODCOLORREF  cVal,
ColorType  type,
bool  bSet = true 
)
inline

Definition at line 207 of file TrVisVisualStyle.h.

◆ set() [7/8]

void OdTrVisVisualStyleProperty::set ( OdInt32  iVal,
bool  bSet = true 
)
inline

Definition at line 195 of file TrVisVisualStyle.h.

◆ set() [8/8]

void OdTrVisVisualStyleProperty::set ( OdUInt32  uVal,
bool  bSet = true,
bool  bAsColor = false 
)
inline

Definition at line 201 of file TrVisVisualStyle.h.

◆ setFlag()

void OdTrVisVisualStyleProperty::setFlag ( OdUInt32  nFlag,
bool  bSet 
)
inline

Definition at line 271 of file TrVisVisualStyle.h.

◆ setModified()

void OdTrVisVisualStyleProperty::setModified ( bool  bSet)
inline

Definition at line 281 of file TrVisVisualStyle.h.

◆ setOperation()

void OdTrVisVisualStyleProperty::setOperation ( bool  bSet)
inline

Definition at line 268 of file TrVisVisualStyle.h.

◆ setPropertyNumber()

void OdTrVisVisualStyleProperty::setPropertyNumber ( OdUInt32  propNum)
inline

Definition at line 184 of file TrVisVisualStyle.h.

◆ setType()

void OdTrVisVisualStyleProperty::setType ( OdGiVariant::VariantType  type)
inlineprotected

Definition at line 152 of file TrVisVisualStyle.h.

◆ type()

OdGiVariant::VariantType OdTrVisVisualStyleProperty::type ( ) const
inline

Definition at line 187 of file TrVisVisualStyle.h.

Member Data Documentation

◆ m_data

union OdTrVisVisualStyleProperty::TypeData OdTrVisVisualStyleProperty::m_data
protected

◆ m_type

struct OdTrVisVisualStyleProperty::DataType OdTrVisVisualStyleProperty::m_type
protected

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