CODFillProperties Class

class CODFillProperties: public CODProperty, public CPropertyContainer< IODPropertyContainer, sfl::CPropertyAccessor< CODFillProperties > >

This class is both a property and a container for properties. It implements the IODPropertyContainer interface for getting and setting values that it contains. Each sub-property contained by fill property objects has a unique identifier (see Fill Property Identifiers) for getting and setting each value. There are also methods to directly set each property.

Defined in: OdFillProp.h

Class Members

VIEWS_API CODFillProperties(int nId = OD_PROP_FILL)

Constructor.

VIEWS_API CODFillProperties(const CODFillProperties& propFill)

Copy constructor.

VIEWS_API virtual ~CODFillProperties()

Destructor.

COLORREF m_crColor

The fill color.

BOOL m_bTransparent

The transparent fill setting

int m_nStyle

The fill style.

int m_nHatch

The hatching style.

int m_nBkMode

The background mode for a hatched brush.

COLORREF m_crBkColor

The background color for a hatched brush.

sfl::SECDib* m_pPattern

A pointer to the bitmap to be used for a fill pattern.

CBitmap* m_pBitmap

A temporary pointer to the bitmap used for creating the brush.

CBrush* m_pBrush

Cached GDI brush.

VIEWS_API COLORREF GetColor() const

Gets the fill color.

VIEWS_API void SetColor(const COLORREF crColor)

Sets the fill color.

VIEWS_API BOOL GetTransparent() const

Gets the transparent setting.

VIEWS_API void SetTransparent(const BOOL bTransparent)

Sets the transparency.

VIEWS_API int GetStyle() const

Gets the fill style.

VIEWS_API void SetStyle(const int nPenStyle)

Sets the fill style.

VIEWS_API int GetBkMode() const

Gets the background mode.

VIEWS_API void SetBkMode(const int nBkMode)

Sets the background mode.

VIEWS_API COLORREF GetBkColor() const

Gets the background color.

VIEWS_API void SetBkColor(const COLORREF crBkColor)

Sets the background color.

VIEWS_API int GetHatch() const

Gets the hatch style.

VIEWS_API void SetHatch(const int nHatch)

Sets the hatch style.

VIEWS_API sfl::SECDib* GetPattern() const

Gets the bitmap used for the fill pattern.

VIEWS_API void SetPattern(sfl::SECDib* pPattern)

Sets the bitmap used for the fill pattern.

VIEWS_API virtual BOOL CompareId(const int nId) const

Compare the property identifier with another identifier.

VIEWS_API CODFillProperties& operator=(const CODFillProperties& propFill)

Sets this set of fill properties equal to another.

VIEWS_API BOOL operator==(const CODFillProperties propFill) const

Determines if another set of fill properties is equal to this one.

VIEWS_API CBrush* CreateBrush(CDC* pDC = NULL)

Creates a GDI brush object. The caller is responsible for freeing this memory!

VIEWS_API CBrush* GetBrush(CDC* pDC = NULL)

Returns a pointer to the cached GDI brush object.

VIEWS_API void ReleaseBrush()

Releases the cached brush object.

VIEWS_API virtual CODProperty* Dup()

Makes a copy of this properties object.

VIEWS_API virtual void Merge(CODProperty* pProperty, DWORD dwChangeFlags = OD_CHANGE_ALL)

Merges another set of properties with this one.

VIEWS_API virtual BOOL IsEqual(CODProperty* pProp)

Determines if another set of properties is equal to this one.

VIEWS_API ULONG STDMETHODCALLTYPE AddRef()

Add a reference to this object.

VIEWS_API ULONG STDMETHODCALLTYPE Release()

Release a reference to this object.

VIEWS_API virtual BOOL GetValue(const int nPropId, CString& strValue) const

Gets the value of the given string property.

VIEWS_API virtual BOOL GetValue(const int nPropId, int& nValue) const

Gets the value of the given integer property.

VIEWS_API virtual BOOL GetValue(const int nPropId, UINT& nValue) const

Gets the value of the given unsigned integer property.

VIEWS_API virtual BOOL GetValue(const int nPropId, DWORD& dwValue) const

Gets the value of the given DWORD property.

VIEWS_API virtual BOOL GetValue(const int nPropId, float& fValue) const

Gets the value of the given float property.

VIEWS_API virtual BOOL SetValue(const int nPropId, LPCTSTR lpszValue)

Sets the value of the given string property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const int nValue)

Sets the value of the given integer property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const UINT nValue)

Sets the value of the given unsigned integer property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const DWORD dwValue)

Sets the value of the given unsigned DWORD property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const float fValue)

Sets the value of the given float property.

VIEWS_API virtual void Serialize(CArchive& ar)

Serializes the line properties.