ISwndContainer Struct Reference

SOUI Window Container Interface. More...

#include <SWndContainer-i.h>

Inheritance diagram for ISwndContainer:

Public Member Functions
BOOL	RegisterTimelineHandler (ITimelineHandler *pHandler) PURE
	Registers an animation frame handler.
BOOL	UnregisterTimelineHandler (ITimelineHandler *pHandler) PURE
	Unregisters an animation frame handler.
BOOL	RegisterDragDrop (SWND swnd, IDropTarget *pDropTarget) PURE
	Registers an IDropTarget with a Swnd.
BOOL	UnregisterDragDrop (SWND swnd) PURE
	Unregisters an IDropTarget from a Swnd.
BOOL	OnFireEvent (IEvtArgs *evt) PURE
	Fires an event.
IMessageLoop *	GetMsgLoop () PURE
	Retrieves the current message loop.
IScriptModule *	GetScriptModule () PURE
	Retrieves the script module.
HWND	GetHostHwnd () PURE
	Retrieves the handle to the host window.
BOOL	IsTranslucent () SCONST PURE
	Checks if the host window is translucent.
BOOL	IsSendWheel2Hover () SCONST PURE
	Checks if mouseWheel messages are sent to the hover window.
int	GetScale () SCONST PURE
	Retrieves the current DPI scale factor.
LPCWSTR	GetTranslatorContext () SCONST PURE
	Retrieves the translation context.
void	GetContainerRect (RECT *ret) SCONST PURE
	Retrieves the container's display rectangle.
void	UpdateRegion (IRegionS *rgn) PURE
	Updates the specified region of the memory bitmap.
void	OnRedraw (LPCRECT rc, BOOL bClip) PURE
	Requests a redraw of the specified area.
SWND	OnGetSwndCapture () SCONST PURE
	Retrieves the Swnd object that has captured the mouse.
SWND	OnSetSwndCapture (SWND swnd) PURE
	Sets the Swnd object to capture the mouse.
BOOL	OnReleaseSwndCapture () PURE
	Releases the mouse capture from the Swnd object.
SWND	GetHover () SCONST PURE
	Retrieves the Swnd object that is hovered over.
SWND	GetFocus () SCONST PURE
	Retrieves the Swnd object that has focus.
void	OnSetSwndFocus (SWND swnd) PURE
	Sets the focus to the specified Swnd object.
BOOL	UpdateWindow (BOOL bForce=TRUE) PURE
	Requests an immediate update of the window.
void	UpdateTooltip () PURE
	Requests an update of the tooltip.
void	SetToolTip (LPCRECT rc, UINT tipAlign, LPCTSTR pszTip) PURE
	Displays a tooltip at the specified position.
void	FrameToHost (RECT *rc) SCONST PURE
	Converts the rectangle coordinates of the current frame to the final host coordinates.
IAcceleratorMgr *	GetAcceleratorMgr () PURE
	Retrieves the accelerator manager.
BOOL	RegisterTrackMouseEvent (SWND swnd) PURE
	Registers a Swnd as a TrackMouseEvent window.
BOOL	UnregisterTrackMouseEvent (SWND swnd) PURE
	Unregisters a Swnd as a TrackMouseEvent window.
void	MarkWndTreeZorderDirty () PURE
	Marks the window tree's z-order as dirty.
void	BuildWndTreeZorder () PURE
	Rebuilds the window tree's z-order.
void	EnableIME (BOOL bEnable) PURE
	Enables or disables the input method editor (IME).
void	OnUpdateCursor () PURE
	Updates the cursor.
BOOL	RegisterVideoCanvas (SWND swnd) PURE
	Registers a VideoCanvas window.
BOOL	UnregisterVideoCanvas (SWND swnd) PURE
	Unregisters a VideoCanvas window.
void	EnableHostPrivateUiDef (BOOL bEnable) PURE
	Enables or disables the host's private UI definitions.
BOOL	PostTask (IRunnable *runable, BOOL bAsync=TRUE) PURE
	Posts a task to the message queue.
int	RemoveTasksForObject (void *pObj) PURE
	Removes all tasks associated with an object.

Detailed Description

SOUI Window Container Interface.

This interface defines the methods for managing a window container in SOUI.

Definition at line 51 of file SWndContainer-i.h.

Member Function Documentation

BuildWndTreeZorder()

void ISwndContainer::BuildWndTreeZorder

(

)

Rebuilds the window tree's z-order.

Returns

void

EnableHostPrivateUiDef()

void ISwndContainer::EnableHostPrivateUiDef

(

BOOL

bEnable

)

Enables or disables the host's private UI definitions.

Parameters

bEnable

TRUE to enable, FALSE to disable.

Returns

void

EnableIME()

void ISwndContainer::EnableIME

(

BOOL

bEnable

)

Enables or disables the input method editor (IME).

Parameters

bEnable

TRUE to enable IME, FALSE to disable.

Returns

void

FrameToHost()

void ISwndContainer::FrameToHost

(

RECT *

rc

)

Converts the rectangle coordinates of the current frame to the final host coordinates.

Parameters

rc	Pointer to the RECT structure containing the rectangle to convert.

Returns

void

GetAcceleratorMgr()

IAcceleratorMgr * ISwndContainer::GetAcceleratorMgr

(

)

Retrieves the accelerator manager.

Returns

Pointer to the IAcceleratorMgr interface.

GetContainerRect()

void ISwndContainer::GetContainerRect

(

RECT *

ret

)

Retrieves the container's display rectangle.

Parameters

ret	Pointer to the RECT structure to receive the container's display rectangle.

Returns

void

GetFocus()

SWND ISwndContainer::GetFocus

(

)

Retrieves the Swnd object that has focus.

Returns

Handle to the Swnd object that has focus.

GetHostHwnd()

HWND ISwndContainer::GetHostHwnd

(

)

Retrieves the handle to the host window.

Returns

Handle to the host window (HWND).

GetHover()

SWND ISwndContainer::GetHover

(

)

Retrieves the Swnd object that is hovered over.

Returns

Handle to the Swnd object that is hovered over.

GetMsgLoop()

IMessageLoop * ISwndContainer::GetMsgLoop

(

)

Retrieves the current message loop.

Returns

Pointer to the IMessageLoop interface.

GetScale()

int ISwndContainer::GetScale

(

)

Retrieves the current DPI scale factor.

Returns

The scale factor.

GetScriptModule()

IScriptModule * ISwndContainer::GetScriptModule

(

)

Retrieves the script module.

Returns

Pointer to the IScriptModule interface.

GetTranslatorContext()

LPCWSTR ISwndContainer::GetTranslatorContext

(

)

Retrieves the translation context.

Returns

The translation context.

IsSendWheel2Hover()

BOOL ISwndContainer::IsSendWheel2Hover

(

)

Checks if mouseWheel messages are sent to the hover window.

Returns

TRUE if mouseWheel messages are sent to the hover window, FALSE if sent to the focus window.

IsTranslucent()

BOOL ISwndContainer::IsTranslucent

(

)

Checks if the host window is translucent.

Returns

TRUE if the host window is translucent.

MarkWndTreeZorderDirty()

void ISwndContainer::MarkWndTreeZorderDirty

(

)

Marks the window tree's z-order as dirty.

Returns

void

OnFireEvent()

BOOL ISwndContainer::OnFireEvent

(

IEvtArgs *

evt

)

Fires an event.

Parameters

evt	Pointer to the IEvtArgs event.

Returns

TRUE if the event was handled.

OnGetSwndCapture()

SWND ISwndContainer::OnGetSwndCapture

(

)

Retrieves the Swnd object that has captured the mouse.

Returns

Handle to the Swnd object that has captured the mouse.

OnRedraw()

void ISwndContainer::OnRedraw	(	LPCRECT	rc,
		BOOL	bClip )

Requests a redraw of the specified area.

Parameters

rc	Pointer to the LPCRECT structure defining the area to redraw.
bClip	TRUE if the area should be clipped.

Returns

void

OnReleaseSwndCapture()

BOOL ISwndContainer::OnReleaseSwndCapture

(

)

Releases the mouse capture from the Swnd object.

Returns

TRUE if successful.

OnSetSwndCapture()

SWND ISwndContainer::OnSetSwndCapture

(

SWND

swnd

)

Sets the Swnd object to capture the mouse.

Parameters

swnd	Handle to the Swnd object to capture the mouse.

Returns

Handle to the previous Swnd object that had capture.

OnSetSwndFocus()

void ISwndContainer::OnSetSwndFocus

(

SWND

swnd

)

Sets the focus to the specified Swnd object.

Parameters

swnd	Handle to the Swnd object to set focus to.

Returns

void

OnUpdateCursor()

void ISwndContainer::OnUpdateCursor

(

)

Updates the cursor.

Returns

void

PostTask()

BOOL ISwndContainer::PostTask	(	IRunnable *	runable,
		BOOL	bAsync = TRUE )

Posts a task to the message queue.

Parameters

runable	Pointer to the IRunnable task object.
bAsync	TRUE to execute asynchronously, FALSE to execute synchronously.

Returns

TRUE if successful.

RegisterDragDrop()

BOOL ISwndContainer::RegisterDragDrop	(	SWND	swnd,
		IDropTarget *	pDropTarget )

Registers an IDropTarget with a Swnd.

Parameters

swnd	Handle to the target window.
pDropTarget	Pointer to the IDropTarget interface.

Returns

TRUE if successful.

RegisterTimelineHandler()

BOOL ISwndContainer::RegisterTimelineHandler

(

ITimelineHandler *

pHandler

)

Registers an animation frame handler.

Parameters

pHandler

Pointer to the ITimelineHandler interface.

Returns

TRUE if successful.

RegisterTrackMouseEvent()

BOOL ISwndContainer::RegisterTrackMouseEvent

(

SWND

swnd

)

Registers a Swnd as a TrackMouseEvent window.

Parameters

swnd	Handle to the target window.

Returns

TRUE if successful.

Remarks

After registration, the Swnd can capture hover and leave messages even if it is obscured by other windows.

RegisterVideoCanvas()

BOOL ISwndContainer::RegisterVideoCanvas

(

SWND

swnd

)

Registers a VideoCanvas window.

Parameters

swnd	Handle to the VideoCanvas window.

Returns

TRUE if successful.

RemoveTasksForObject()

int ISwndContainer::RemoveTasksForObject

(

void *

pObj

)

Removes all tasks associated with an object.

Parameters

pObj	Pointer to the object.

Returns

The number of tasks removed.

SetToolTip()

void ISwndContainer::SetToolTip	(	LPCRECT	rc,
		UINT	tipAlign,
		LPCTSTR	pszTip )

Displays a tooltip at the specified position.

Parameters

rc	Pointer to the LPCRECT structure defining the position of the tooltip relative to the container.
tipAlign	Alignment flags for the tooltip.
pszTip	Content of the tooltip, set to NULL to exit a fixed tooltip.

Returns

void

UnregisterDragDrop()

BOOL ISwndContainer::UnregisterDragDrop

(

SWND

swnd

)

Unregisters an IDropTarget from a Swnd.

Parameters

swnd	Handle to the target window.

Returns

TRUE if successful.

UnregisterTimelineHandler()

BOOL ISwndContainer::UnregisterTimelineHandler

(

ITimelineHandler *

pHandler

)

Unregisters an animation frame handler.

Parameters

pHandler

Pointer to the ITimelineHandler interface.

Returns

TRUE if successful.

UnregisterTrackMouseEvent()

BOOL ISwndContainer::UnregisterTrackMouseEvent

(

SWND

swnd

)

Unregisters a Swnd as a TrackMouseEvent window.

Parameters

swnd	Handle to the target window.

Returns

TRUE if successful.

Remarks

After registration, the Swnd can capture hover and leave messages even if it is obscured by other windows.

UnregisterVideoCanvas()

BOOL ISwndContainer::UnregisterVideoCanvas

(

SWND

swnd

)

Unregisters a VideoCanvas window.

Parameters

swnd	Handle to the VideoCanvas window.

Returns

TRUE if successful.

UpdateRegion()

void ISwndContainer::UpdateRegion

(

IRegionS *

rgn

)

Updates the specified region of the memory bitmap.

Parameters

rgn	Pointer to the IRegionS region to update.

Returns

void

UpdateTooltip()

void ISwndContainer::UpdateTooltip

(

)

Requests an update of the tooltip.

Returns

void

UpdateWindow()

BOOL ISwndContainer::UpdateWindow

(

BOOL

bForce = TRUE

)

Requests an immediate update of the window.

Parameters

bForce

TRUE to force a refresh, FALSE to refresh only if there are invalid regions.

Returns

TRUE if successful.

---

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

• SOUI/include/interface/SWndContainer-i.h