SHostWndAttr Class Reference

Class defining attributes for the host window. More...

#include <SHostWnd.h>

Inheritance diagram for SHostWndAttr:

Public Member Functions
	SHostWndAttr (void)
	Constructor for SHostWndAttr.
	~SHostWndAttr ()
	Destructor for SHostWndAttr.
void	Init ()
	Initializes the window attributes.
virtual LPCWSTR	GetTrCtx () const
	Gets the translation context.
CRect	GetMaxInset (int nScale) const
	Gets the maximum inset size of the window.
CRect	GetMargin (int nScale) const
	Gets the margin of the window.
CSize	GetMinSize (int nScale) const
	Gets the minimum size of the window.
void	SetTranslucent (bool bTranslucent)
	Sets whether the window is translucent.
void	SetTrCtx (const SStringW &strTrCtx)
	Sets the translation context.
void	SetSendWheel2Hover (bool value)
	Sets whether wheel messages are sent to the hover window.
virtual HRESULT	SetAttribute (const SNS::SStringW &strAttribName, const SNS::SStringW &strValue, BOOL bLoading=FALSE)
	Defines the attribute list for serialization and deserialization.
Public Member Functions inherited from TObjRefImpl< SObject >
	TObjRefImpl ()
	Constructor that initializes the reference count to 1.
virtual	~TObjRefImpl ()
	Virtual destructor.
long	AddRef () override
	Increments the reference count.
long	Release () override
	Decrements the reference count and deletes the object if the count reaches zero.
void	OnFinalRelease () override
	Deletes the object.

Protected Attributes
SLayoutSize	m_rcMargin [4]
SLayoutSize	m_szMin [2]
SLayoutSize	m_rcMaxInset [4]
WndType	m_wndType
BOOL	m_bResizable
BOOL	m_bAppWnd
BOOL	m_bToolWnd
BOOL	m_bTranslucent
BOOL	m_bAutoShape
BOOL	m_bAllowSpy
BOOL	m_bSendWheel2Hover
BOOL	m_bHasMsgLoop
DWORD	m_dwStyle
DWORD	m_dwExStyle
SStringW	m_strTrCtx
SStringW	m_strTitle
HICON	m_hAppIconSmall
HICON	m_hAppIconBig
Protected Attributes inherited from TObjRefImpl< SObject >
LONG	m_cRef
	Reference count.

Friends
class	SHostWnd
	Friend class declaration allowing access to private members.
class	SRootWindow
class	SNcPainter
class	SHostPresenter

Detailed Description

Class defining attributes for the host window.

This class manages and configures the appearance and behavior of the host window.

Definition at line 42 of file SHostWnd.h.

Constructor & Destructor Documentation

SHostWndAttr()

SHostWndAttr::SHostWndAttr

(

void

)

Constructor for SHostWndAttr.

Definition at line 56 of file shostwnd.cpp.

~SHostWndAttr()

SHostWndAttr::~SHostWndAttr

(

)

Destructor for SHostWndAttr.

Definition at line 63 of file shostwnd.cpp.

Member Function Documentation

GetMargin()

CRect SHostWndAttr::GetMargin

(

int

nScale

)

const

Gets the margin of the window.

Parameters

nScale

Scale factor.

Returns

Margin rectangle.

Definition at line 107 of file shostwnd.cpp.

GetMaxInset()

CRect SHostWndAttr::GetMaxInset

(

int

nScale

)

const

Gets the maximum inset size of the window.

Parameters

nScale

Scale factor.

Returns

Maximum inset rectangle.

Definition at line 97 of file shostwnd.cpp.

GetMinSize()

CSize SHostWndAttr::GetMinSize

(

int

nScale

)

const

Gets the minimum size of the window.

Parameters

nScale

Scale factor.

Returns

Minimum size.

Definition at line 117 of file shostwnd.cpp.

GetTrCtx()

LPCWSTR SHostWndAttr::GetTrCtx ( ) const

virtual

Gets the translation context.

Returns

Translation context string.

Definition at line 92 of file shostwnd.cpp.

Init()

void SHostWndAttr::Init

(

)

Initializes the window attributes.

Definition at line 71 of file shostwnd.cpp.

SetAttribute()

virtual HRESULT SHostWndAttr::SetAttribute ( const SNS::SStringW & strAttribName, const SNS::SStringW & strValue, BOOL bLoading = FALSE )

inlinevirtual

Defines the attribute list for serialization and deserialization.

Definition at line 134 of file SHostWnd.h.

SetSendWheel2Hover()

void SHostWndAttr::SetSendWheel2Hover

(

bool

value

)

Sets whether wheel messages are sent to the hover window.

Parameters

value

TRUE to send wheel messages to the hover window, FALSE otherwise.

Definition at line 135 of file shostwnd.cpp.

SetTranslucent()

void SHostWndAttr::SetTranslucent

(

bool

bTranslucent

)

Sets whether the window is translucent.

Parameters

bTranslucent

TRUE if the window is translucent, FALSE otherwise.

Definition at line 125 of file shostwnd.cpp.

SetTrCtx()

void SHostWndAttr::SetTrCtx

(

const SStringW &

strTrCtx

)

Sets the translation context.

Parameters

strTrCtx

Translation context string.

Definition at line 130 of file shostwnd.cpp.

Friends And Related Symbol Documentation

SHostPresenter

friend class SHostPresenter

friend

Definition at line 61 of file SHostWnd.h.

SHostWnd

friend class SHostWnd

friend

Friend class declaration allowing access to private members.

Definition at line 58 of file SHostWnd.h.

SNcPainter

friend class SNcPainter

friend

Definition at line 60 of file SHostWnd.h.

SRootWindow

friend class SRootWindow

friend

Definition at line 59 of file SHostWnd.h.

Member Data Documentation

m_bAllowSpy

BOOL SHostWndAttr::m_bAllowSpy

protected

Flag indicating if spy is allowed

Definition at line 170 of file SHostWnd.h.

m_bAppWnd

BOOL SHostWndAttr::m_bAppWnd

protected

Flag indicating if the window is an APP window (shown in taskbar)

Definition at line 166 of file SHostWnd.h.

m_bAutoShape

BOOL SHostWndAttr::m_bAutoShape

protected

Flag indicating if the window should auto-build shape for translucency (valid for Linux)

Definition at line 169 of file SHostWnd.h.

m_bHasMsgLoop

BOOL SHostWndAttr::m_bHasMsgLoop

protected

Flag indicating if the window has a message loop, affecting tooltip RelayEvent timing

Definition at line 172 of file SHostWnd.h.

m_bResizable

BOOL SHostWndAttr::m_bResizable

protected

Flag indicating if the window is resizable

Definition at line 165 of file SHostWnd.h.

m_bSendWheel2Hover

BOOL SHostWndAttr::m_bSendWheel2Hover

protected

Flag indicating if wheel messages should be sent to the hover window

Definition at line 171 of file SHostWnd.h.

m_bToolWnd

BOOL SHostWndAttr::m_bToolWnd

protected

Flag indicating if the window has WS_ES_TOOLWINDOW style

Definition at line 167 of file SHostWnd.h.

m_bTranslucent

BOOL SHostWndAttr::m_bTranslucent

protected

Flag indicating if the window is translucent

Definition at line 168 of file SHostWnd.h.

m_dwExStyle

DWORD SHostWndAttr::m_dwExStyle

protected

Definition at line 174 of file SHostWnd.h.

m_dwStyle

DWORD SHostWndAttr::m_dwStyle

protected

Definition at line 173 of file SHostWnd.h.

m_hAppIconBig

HICON SHostWndAttr::m_hAppIconBig

protected

Definition at line 179 of file SHostWnd.h.

m_hAppIconSmall

HICON SHostWndAttr::m_hAppIconSmall

protected

Definition at line 178 of file SHostWnd.h.

m_rcMargin

SLayoutSize SHostWndAttr::m_rcMargin[4]

protected

Window stretch edge detection size

Definition at line 160 of file SHostWnd.h.

m_rcMaxInset

SLayoutSize SHostWndAttr::m_rcMaxInset[4]

protected

Window maximum inset size when maximized. WS_OVERLAPPED style windows ignore this attribute

Definition at line 162 of file SHostWnd.h.

m_strTitle

SStringW SHostWndAttr::m_strTitle

protected

Definition at line 177 of file SHostWnd.h.

m_strTrCtx

SStringW SHostWndAttr::m_strTrCtx

protected

Translation context used in language translation

Definition at line 176 of file SHostWnd.h.

m_szMin

SLayoutSize SHostWndAttr::m_szMin[2]

protected

Window minimum size

Definition at line 161 of file SHostWnd.h.

m_wndType

WndType SHostWndAttr::m_wndType

protected

Main window flag, if set, the window sends WM_QUIT on close

Definition at line 164 of file SHostWnd.h.

---

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

• SOUI/include/core/SHostWnd.h
• SOUI/src/core/shostwnd.cpp