Mobile SDK for Windows Apps2.0
Transforming Windows apps into Mobile apps
ICMPEvents Struct Reference

The event interface for all the CMP events. More...

#include <Events.h>

List of all members.

Public Member Functions

HRESULT SessionStateChanged ([in]CMP_SESSION_STATE SessState)
 Event: Session state changed.
HRESULT ChannelStateChanged ([in]CMP_CHANNEL_STATE ChnlState)
 Event: Channel state changed.
HRESULT OrientationChanged ([in]CMPRESULT rc,[in]CMP_ORIENTATION_POSITION DeviceOrientation,[in]CMP_ORIENTATION_POSITION AppOrientation,[in]INT16 OrientationFlags)
 Event: Orientation changed.
HRESULT PictureTaken ([in]CMPRESULT rc,[in]CMP_UNIQUE_ID PictureID,[in]CMP_IMAGE_FORMAT Format,[in]INT32 PictureSize,[in]BSTR Filename)
 Event: Picture taken.
HRESULT SMSStarted ([in]CMPRESULT rc,[in]CMP_UNIQUE_ID MsgId)
 Event: Send SMS Started.
HRESULT ButtonPressed ([in]CMP_BUTTON_ID Button)
 Event: Device button was pressed.
HRESULT DisplaySettingsChanged ([in]INT16 MetricsFlags,[in]INT32 PixelWidth,[in]INT32 PixelHeight,[in]INT16 ColorDepth,[in]INT32 XPixelsPerInch,[in]INT32 YPixelsPerInch,[in]CMP_ORIENTATION_POSITION DeviceOrientation,[in]INT32 WidthMilliInches,[in]INT32 HeightMilliInches,[in]INT32 NormalizedDPI)
 Event: Display settings have changed.
HRESULT ScrollModeChanged ([in]CMPRESULT rc,[in]CMP_SCROLL_MODE ScrollMode)
 Event: Scroll mode changed.
HRESULT KeyboardStateChanged ([in]CMPRESULT rc,[in]CMP_KEYBOARD_TYPE KybdType,[in]INT16 KybdFlags,[in]CMP_KEYBOARD_AUTOCAPS KybdAutoCaps,[in]CMP_KEYBOARD_RETURNKEY KybdReturnKey)
 Event: Keyboard state changed.
HRESULT ViewportOriginChanged ([in]CMPRESULT rc,[in]INT32 xLeft,[in]INT32 yTop)
 Event: Viewport origin changed.
HRESULT ButtonTargetChanged ([in]CMPRESULT rc,[in]CMP_BUTTON_ID Button,[in]CMP_BUTTON_TARGET ButtonTarget)
 Event: Button target changed.
HRESULT ControlStateChanged ([in]CMPRESULT rc,[in]INT16 ControlState)
 Event: Control state changed.
HRESULT PhoneCallStarted ([in]CMPRESULT rc,[in]CMP_UNIQUE_ID CallId)
 Event: Phone call started.
HRESULT UserNotified ([in]CMPRESULT rc,[in]CMP_UNIQUE_ID NotificationId)
 Event: User notified.
HRESULT CameraPictureRemoved ([in]CMPRESULT rc,[in]CMP_UNIQUE_ID pictureId)
 Event: Picture removed.
HRESULT EventFilterChanged ([in]CMPRESULT rc,[in]CMP_EVENT_ID EventId,[in]INT16 FilterFlags)
 Event: Filter changed.
HRESULT PickerControlStateChanged ([in]CMP_UNIQUE_ID ControlId,[in]INT16 PickerFlags,[in]CMPRESULT result,[in]INT16 SelectedItemIndex)
 Event: Picker control state changed.
HRESULT ViewportChanged ([in]CMPRESULT rc,[in]INT16 flags,[in]INT16 zoomFactor,[in]INT32 x0Server,[in]INT32 y0Server,[in]INT32 x1Server,[in]INT32 y1Server,[in]INT32 x0Client,[in]INT32 y0Client,[in]INT32 x1Client,[in]INT32 y1Client)
 Event: Viewport changed.
HRESULT PictureCaptured ([in]CMPRESULT rc,[in]CMP_UNIQUE_LONG_ID uniqueId,[in]BSTR pictureMetadata,[in]BSTR filename,[in]BSTR thumbnail,[in]INT32 pictureSize,[in]CMP_CAPTURE_QUALITY Quality,[in]CMP_CAPTURE_CAMERA CameraSelection,[in]CMP_IMAGE_FORMAT Encoding,[in]INT32 DesiredWidth,[in]INT32 DesiredHeight,[in]CMP_THUMBNAIL_TYPE ThumbnailType,[in]INT16 ThumbnailWidth,[in]INT16 ThumbnailHeight)
HRESULT VideoCaptured ([in]CMPRESULT rc,[in]CMP_UNIQUE_LONG_ID uniqueId,[in]BSTR videoMetadata,[in]BSTR filename,[in]INT32 videoSize,[in]CMP_CAPTURE_QUALITY Quality,[in]CMP_CAPTURE_CAMERA CameraSelection,[in]CMP_VIDEO_ENCODING Encoding,[in]INT32 DesiredWidth,[in]INT32 DesiredHeight,[in]INT32 DurationLimit)
HRESULT AudioCaptured ([in]CMPRESULT rc,[in]CMP_UNIQUE_LONG_ID uniqueId,[in]BSTR audioMetadata,[in]BSTR filename,[in]INT32 audioSize,[in]CMP_CAPTURE_QUALITY Quality,[in]CMP_AUDIO_ENCODING Encoding,[in]INT32 DurationLimit)
HRESULT SupportedOrientationsChanged ([in]CMPRESULT rc,[in]CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
HRESULT AppForeground ()
HRESULT AppBackground ()
HRESULT ForegroundAppChanged ([in]DWORD foregroundProcessId)
HRESULT CaptureMediaRemoved ([in]CMPRESULT rc,[in]CMP_UNIQUE_LONG_ID captureId)

Detailed Description

The event interface for all the CMP events.

Since this events interface is based on dispinterface, it is okay to extend it with new events at the end. Just make sure to use new dispatch ids that do not overlap.


Member Function Documentation

HRESULT ICMPEvents::AudioCaptured ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_LONG_ID  uniqueId,
[in] BSTR  audioMetadata,
[in] BSTR  filename,
[in] INT32  audioSize,
[in] CMP_CAPTURE_QUALITY  Quality,
[in] CMP_AUDIO_ENCODING  Encoding,
[in] INT32  DurationLimit 
)
HRESULT ICMPEvents::ButtonPressed ( [in] CMP_BUTTON_ID  Button)

Event: Device button was pressed.

Parameters:
[in]Buttonbutton that was pressed
HRESULT ICMPEvents::ButtonTargetChanged ( [in] CMPRESULT  rc,
[in] CMP_BUTTON_ID  Button,
[in] CMP_BUTTON_TARGET  ButtonTarget 
)

Event: Button target changed.

Parameters:
[in]rcresult of last request
[in]Buttonbutton identifier
[in]ButtonTargeteither client or host location
HRESULT ICMPEvents::CameraPictureRemoved ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_ID  pictureId 
)

Event: Picture removed.

Parameters:
[in]rcresult of last request
[in]pictureIdunique picture identifier
HRESULT ICMPEvents::CaptureMediaRemoved ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_LONG_ID  captureId 
)

Event: Channel state changed.

Parameters:
[in]ChnlStatelatest state for the channel
HRESULT ICMPEvents::ControlStateChanged ( [in] CMPRESULT  rc,
[in] INT16  ControlState 
)

Event: Control state changed.

Parameters:
[in]rcresult of last request
[in]ControlStateflags that indicate the state of the receiver controls
HRESULT ICMPEvents::DisplaySettingsChanged ( [in] INT16  MetricsFlags,
[in] INT32  PixelWidth,
[in] INT32  PixelHeight,
[in] INT16  ColorDepth,
[in] INT32  XPixelsPerInch,
[in] INT32  YPixelsPerInch,
[in] CMP_ORIENTATION_POSITION  DeviceOrientation,
[in] INT32  WidthMilliInches,
[in] INT32  HeightMilliInches,
[in] INT32  NormalizedDPI 
)

Event: Display settings have changed.

Parameters:
[in]MetricsFlagsflags that indicate which of the following parameters is valid
[in]PixelWidthwidth of display in pixels
[in]PixelHeightheight of display in pixels
[in]ColorDepthcolor bits per pixel
[in]XPixelsPerInchpixels per inch on horizontal axis
[in]YPixelsPerInchpixels per inch on vertical axis
[in]DeviceOrientationdevice orientation
[in]WidthMilliIncheswidth in milli-inches (1/1000 of an inch)
[in]HeightMilliInchesheight in milli-inches (1/1000 of an inch)
[in]NormalizedDPIsome devices only report this approximate DPI value
HRESULT ICMPEvents::EventFilterChanged ( [in] CMPRESULT  rc,
[in] CMP_EVENT_ID  EventId,
[in] INT16  FilterFlags 
)

Event: Filter changed.

Parameters:
[in]rcresult of last request
[in]EventIdevent identifier
[in]FilterFlagsflags for event filter (disable or enable)
HRESULT ICMPEvents::ForegroundAppChanged ( [in] DWORD  foregroundProcessId)
HRESULT ICMPEvents::KeyboardStateChanged ( [in] CMPRESULT  rc,
[in] CMP_KEYBOARD_TYPE  KybdType,
[in] INT16  KybdFlags,
[in] CMP_KEYBOARD_AUTOCAPS  KybdAutoCaps,
[in] CMP_KEYBOARD_RETURNKEY  KybdReturnKey 
)

Event: Keyboard state changed.

Parameters:
[in]rcresult of last request
[in]KybdTypetype of keyboard that is displayed
[in]KybdFlagsflags associated with keyboard
[in]KybdAutoCapsauto capitalization mode selected
[in]KybdReturnKeyreturn key text selected
HRESULT ICMPEvents::OrientationChanged ( [in] CMPRESULT  rc,
[in] CMP_ORIENTATION_POSITION  DeviceOrientation,
[in] CMP_ORIENTATION_POSITION  AppOrientation,
[in] INT16  OrientationFlags 
)

Event: Orientation changed.

Parameters:
[in]rcresult of last request
[in]DeviceOrientationorientation position of the device
[in]AppOrientationorientation of the application
[in]OrientationFlagsEither sensor follow or lock
HRESULT ICMPEvents::PhoneCallStarted ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_ID  CallId 
)

Event: Phone call started.

Parameters:
[in]rcresult of last request
[in]CallIdunique phone call identifier for request
HRESULT ICMPEvents::PickerControlStateChanged ( [in] CMP_UNIQUE_ID  PickerId,
[in] INT16  PickerFlags,
[in] CMPRESULT  result,
[in] INT16  SelectedItemIndex 
)

Event: Picker control state changed.

Parameters:
[in]PickerIdunique identifier for picker control
[in]PickerFlagsflags for picker control
[in]resultresult of last request
[in]SelectedItemIndexselected list item
HRESULT ICMPEvents::PictureCaptured ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_LONG_ID  uniqueId,
[in] BSTR  pictureMetadata,
[in] BSTR  filename,
[in] BSTR  thumbnail,
[in] INT32  pictureSize,
[in] CMP_CAPTURE_QUALITY  Quality,
[in] CMP_CAPTURE_CAMERA  CameraSelection,
[in] CMP_IMAGE_FORMAT  Encoding,
[in] INT32  DesiredWidth,
[in] INT32  DesiredHeight,
[in] CMP_THUMBNAIL_TYPE  ThumbnailType,
[in] INT16  ThumbnailWidth,
[in] INT16  ThumbnailHeight 
)
HRESULT ICMPEvents::PictureTaken ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_ID  PictureId,
[in] CMP_IMAGE_FORMAT  Format,
[in] INT32  PictureSize,
[in] BSTR  Filename 
)

Event: Picture taken.

Parameters:
[in]rcresult of last request
[in]PictureIdunique picture identifier
[in]Formattype of picture taken (JPEG, PNG)
[in]PictureSizesize of the picture
[in]Filenamelocation of picture using filename
HRESULT ICMPEvents::ScrollModeChanged ( [in] CMPRESULT  rc,
[in] CMP_SCROLL_MODE  scrollMode 
)

Event: Scroll mode changed.

Parameters:
[in]rcresult of last request
[in]scrollModecurrent scroll mode

Event: Session state changed.

Parameters:
[in]SessStatelatest state for the session
HRESULT ICMPEvents::SMSStarted ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_ID  MsgId 
)

Event: Send SMS Started.

Parameters:
[in]rcresult of last request
[in]MsgIdunique SMS identifier for request
HRESULT ICMPEvents::SupportedOrientationsChanged ( [in] CMPRESULT  rc,
[in] CMP_SUPPORTED_ORIENTATIONS  supportedOrientations 
)
HRESULT ICMPEvents::UserNotified ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_ID  NotificationId 
)

Event: User notified.

Parameters:
[in]rcresult of last request
[in]NotificationIdunique notification identifier
HRESULT ICMPEvents::VideoCaptured ( [in] CMPRESULT  rc,
[in] CMP_UNIQUE_LONG_ID  uniqueId,
[in] BSTR  videoMetadata,
[in] BSTR  filename,
[in] INT32  videoSize,
[in] CMP_CAPTURE_QUALITY  Quality,
[in] CMP_CAPTURE_CAMERA  CameraSelection,
[in] CMP_VIDEO_ENCODING  Encoding,
[in] INT32  DesiredWidth,
[in] INT32  DesiredHeight,
[in] INT32  DurationLimit 
)
HRESULT ICMPEvents::ViewportChanged ( [in] CMPRESULT  rc,
[in] INT16  flags,
[in] INT16  zoomFactor,
[in] INT32  x0Server,
[in] INT32  y0Server,
[in] INT32  x1Server,
[in] INT32  y1Server,
[in] INT32  x0Client,
[in] INT32  y0Client,
[in] INT32  x1Client,
[in] INT32  y1Client 
)

Event: Viewport changed.

Parameters:
[in]rcresult of last request
[in]flagsindicates which fields are valid
[in]zoomFactoramount of zoom to applied to server viewport
[in]x0Serverserver viewport left x coordinate
[in]y0Serverserver viewport top y coordinate
[in]x1Serverserver viewport right x coordinate
[in]y1Serverserver viewport bottom y coordinate
[in]x0Clientclient viewport left x coordinate
[in]y0Clientclient viewport top y coordinate
[in]x1Clientclient viewport right x coordinate
[in]y1Clientclient viewport bottom y coordinate
HRESULT ICMPEvents::ViewportOriginChanged ( [in] CMPRESULT  rc,
[in] INT32  xLeft,
[in] INT32  yTop 
)

Event: Viewport origin changed.

Parameters:
[in]rcresult of last request
[in]xLeftleft most position
[in]yToptop most position

The documentation for this struct was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Events Defines