IDisplay Struct Reference

#include <Display.h>

Inherited by CitrixMobile.

List of all members.

Public Member Functions
STDMETHODIMP	GetOrientation ([out]CMP_ORIENTATION_DATA *orientationData,[out, retval]CMPRESULT *result)
	Get current orientation data.
STDMETHODIMP	SetOrientation ([in]CMP_ORIENTATION_POSITION orientation,[in]INT16 orientationFlags,[out, retval]CMPRESULT *result)
	Set the application orientation.
STDMETHODIMP	GetScrollMode ([out]CMP_SCROLL_MODE *scrollMode,[out, retval]CMPRESULT *result)
	Get current scroll mode.
STDMETHODIMP	SetScrollMode ([in]CMP_SCROLL_MODE scrollMode,[out, retval]CMPRESULT *result)
	Set the scroll mode from the mobile device.
STDMETHODIMP	SetViewportOrigin ([in]CMP_DISPLAY_POINT *pt,[in]INT16 viewportFlags,[out, retval]CMPRESULT *result)
	Set the origin of the Citrix Receiver viewport.
STDMETHODIMP	GetViewportOrigin ([in]CMP_DISPLAY_POINT *pt,[out, retval]CMPRESULT *result)
	Get the origin of the Citrix Receiver viewport.
STDMETHODIMP	GetDisplaySettings ([out]CMP_DISPLAY_SETTINGS *dispSettings,[out, retval]CMPRESULT *result)
	Get the current display settings for the mobile device.
STDMETHODIMP	SetViewport ([in]INT16 flags,[in]INT16 zoomFactor,[in]CMP_DISPLAY_RECT *serverViewport,[out, retval]CMPRESULT *result)
	Set the viewport for the mobile device.
STDMETHODIMP	GetViewport ([out]INT16 *flags,[out]INT16 *zoomFactor,[out]CMP_DISPLAY_RECT *serverViewport,[out]CMP_DISPLAY_RECT *clientViewport,[out, retval]CMPRESULT *result)
	Get the current viewport for the mobile device.

---

Member Function Documentation

STDMETHODIMP IDisplay::GetDisplaySettings	(	[out] CMP_DISPLAY_SETTINGS *	dispSettings,
		[out, retval] CMPRESULT *	result
	)

Get the current display settings for the mobile device.

Parameters:

dispSettings	- retrieved display settings
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::GetOrientation	(	[out] CMP_ORIENTATION_DATA *	orientationData,
		[out,retval] CMPRESULT *	result
	)

Get current orientation data.

Get the current orientation data (application and device orientation, orientation flags) from the mobile device. Device and application orientation can be different based on the orientation flags.

Parameters:

orientationData	- contains the relevant orientation data
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::GetScrollMode	(	[out] CMP_SCROLL_MODE *	scrollMode,
		[out,retval] CMPRESULT *	result
	)

Get current scroll mode.

Get the current scroll mode from the mobile device. For everything we can set, the intention is being able to retrieve those settings as well.

Parameters:

scrollMode	- returned scroll mode
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::GetViewport	(	[out] INT16 *	flags,
		[out] INT16 *	zoomFactor,
		[out] CMP_DISPLAY_RECT *	serverViewport,
		[out] CMP_DISPLAY_RECT *	clientViewport,
		[out,retval] CMPRESULT *	result
	)

Get the current viewport for the mobile device.

Parameters:

flags	indicates which fields are valid
zoomFactor	The amount of zoom used (200 = 2x)
serverViewport	The rectangle coordinates of the server viewport
clientViewport	The rectangle coordinates of the client viewport
result	CMPRESULT

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::GetViewportOrigin	(	[in] CMP_DISPLAY_POINT *	pt,
		[out,retval] CMPRESULT *	result
	)

Get the origin of the Citrix Receiver viewport.

Parameters:

pt	- position of the viewport (top, left)
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::SetOrientation	(	[in] CMP_ORIENTATION_POSITION	orientation,
		[in] INT16	orientationFlags,
		[out,retval] CMPRESULT *	result
	)

Set the application orientation.

Set the application orientation and orientation flags for the mobile device. Device and application orientation can be different based on the orientation flags.

Parameters:

orientation	- contains the relevant orientation data
orientationFlags	- controls the orientation to either be "follow" or "locked"
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::SetScrollMode	(	[in] CMP_SCROLL_MODE	scrollMode,
		[out,retval] CMPRESULT *	result
	)

Set the scroll mode from the mobile device.

Parameters:

scrollMode	- scroll mode to set CMP_SCROLL_MODE
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::SetViewport	(	[in] INT16	flags,
		[in] INT16	zoomFactor,
		[in] CMP_DISPLAY_RECT *	serverViewport,
		[out,retval] CMPRESULT *	result
	)

Set the viewport for the mobile device.

Parameters:

flags	indicates which fields are to be used
zoomFactor	The amount of zoom used (200 = 2x)
serverViewport	The rectangle coordinates of the server viewport
result	CMPRESULT

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP IDisplay::SetViewportOrigin	(	[in] CMP_DISPLAY_POINT *	pt,
		[in] INT16	viewportFlags,
		[out,retval] CMPRESULT *	result
	)

Set the origin of the Citrix Receiver viewport.

Parameters:

pt	- Location to position the viewport (top, left)
viewportFlags	- flags to control how set viewport works
result	- result of the operation

Returns:

HRESULT

Reimplemented in CitrixMobile.

---

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

• Display.h
• cmpcom_en.txt