CitrixMobility.h

Go to the documentation of this file.

#pragma once

// pragma align the structures properly in IDL/Typelib
[idl_quote("#pragma pack(1)")];


// CMPCOM flag turns on all the IDL generation
#define CMPCOM

#include "Capability.h"
#include "Session.h"
#include "Channel.h"
#include "Display.h"
#include "Keyboard.h"
#include "Events.h"
#include "Camera.h"
#include "Phone.h"
#include "Message.h"
#include "Picker.h"
#include "Buttons.h"
#include "Control.h"
#include "Device.h"
#include "Notification.h"
#include "Dispatch.h"
#include "virtualdevice.h"
#include "capture.h"
#include "critsec.h"

#include <cmpabstract.h>

//
// the custom attribute controls the namespace
//
[
   coclass,
   threading(both),
   default(ICMPDispatch),
   vi_progid("Citrix.Mobility"),
   progid("Citrix.Mobility.1"),
   version(1.0),
   uuid("10A7B690-BCAC-4A29-9BB1-6E4D13AFF25B"),
   helpstring("Citrix Mobility COM Class"),
   event_source(com)
]
class CitrixMobile: 
    public IButton,
    public ICamera,
    public ICapabilities,
    public IChannel,
    public ICMPDevice,
    public ICMPDispatch,
    public IControl,
    public IDisplay,
    public IEventFilter,
    public IEventSource,
    public IKeyboard,
    public IMessage,
    public INotification,
    public IPhone,
    public IPicker,
    public ISession,
    public IVirtualDevice,
    public ICMPCapture,
    public IOrientation
{

public:
    __event __interface ICMPEvents;

    CitrixMobile();

    //DECLARE_PROTECT_FINAL_CONSTRUCT()
    HRESULT FinalConstruct();

    void FinalRelease();

    // ISession
    STDMETHODIMP IsSessionActive(VARIANT_BOOL* sessionActive);
    STDMETHODIMP GetSessionState(CMP_SESSION_STATE* sessionState);
    STDMETHODIMP OpenSession(CMPRESULT* result);
    STDMETHODIMP CloseSession(CMPRESULT* result);
    STDMETHODIMP GetErrorText(CMP_ERROR_ID errorId, BSTR *errorText, CMPRESULT* result);
    STDMETHODIMP SetSessionOptionBool(CMP_SESSION_OPTION option, VARIANT_BOOL value, CMPRESULT* rc);
    STDMETHODIMP GetSessionOptionBool(CMP_SESSION_OPTION option, VARIANT_BOOL *value, CMPRESULT* rc);
    STDMETHODIMP RegisterCMPProcess(DWORD processId, CMPRESULT* rc);
    STDMETHODIMP UnregisterCMPProcess(DWORD processId, CMPRESULT* rc);
    STDMETHODIMP DetectCMPProcess(DWORD processId, VARIANT_BOOL *value, CMPRESULT* rc);

    // IChannel
    STDMETHODIMP IsChannelOpen(VARIANT_BOOL *channelStarted);
    STDMETHODIMP OpenChannel(CMP_CHANNEL_FLAGS channelFlags, CMPRESULT* result);
    STDMETHODIMP CloseChannel(CMPRESULT* result);
    STDMETHODIMP GetChannelState(CMP_CHANNEL_STATE *state);

    //ICapabilities
    STDMETHODIMP GetCapabilityBool(CMP_CAP_ID capId, CMP_KEY_ID keyId, VARIANT_BOOL *keyValue, CMPRESULT* result);
    STDMETHODIMP GetCapabilityInt16(CMP_CAP_ID capId, CMP_KEY_ID keyId, INT16 *keyValue, CMPRESULT* result);
    STDMETHODIMP GetCapabilityUInt16(CMP_CAP_ID capId, CMP_KEY_ID keyId, PUINT16 value, CMPRESULT* result);
    STDMETHODIMP GetCapabilityInt32(CMP_CAP_ID capId, CMP_KEY_ID keyId, PINT32 keyValue, CMPRESULT* result);
    STDMETHODIMP GetCapabilityUInt32(CMP_CAP_ID capId, CMP_KEY_ID keyId, PUINT32 keyValue, CMPRESULT* result);

    //IEventSource
    STDMETHODIMP FireSessionStateChangedEvent(CMP_SESSION_STATE state);
    STDMETHODIMP FireChannelStateChangedEvent(CMP_CHANNEL_STATE state);
    STDMETHODIMP FireOrientationChangedEvent(CMPRESULT rc, CMP_ORIENTATION_DATA *orientationData);
    STDMETHODIMP FirePictureTakenEvent(CMPRESULT rc, CMP_UNIQUE_ID imageID, CMP_IMAGE_FORMAT pictType, INT32 pictureSize, BSTR filename);
    STDMETHODIMP FireSMSStartedEvent(CMPRESULT rc, CMP_UNIQUE_ID msgID);
    STDMETHODIMP FireButtonPressedEvent(CMP_BUTTON_ID button);

    STDMETHODIMP FireDisplaySettingsChangedEvent(CMP_DISPLAY_SETTINGS *displayMetrics);
    STDMETHODIMP FireScrollModeChangedEvent(CMPRESULT rc, CMP_SCROLL_MODE scrollMode);
    STDMETHODIMP FireKeyboardStateChangedEvent(CMPRESULT rc, CMP_KEYBOARD_STATE* keyboardState);
    STDMETHODIMP FireViewportOriginChangedEvent(CMPRESULT rc, CMP_DISPLAY_POINT* point);
    STDMETHODIMP FireButtonTargetChangedEvent(CMPRESULT rc, CMP_BUTTON_ID button, CMP_BUTTON_TARGET buttonTarget);
    STDMETHODIMP FireControlStateChangedEvent(CMPRESULT rc, INT16 controlState);
    STDMETHODIMP FirePhoneCallStartedEvent(CMPRESULT rc, CMP_UNIQUE_ID callId);
    STDMETHODIMP FireUserNotifiedEvent(CMPRESULT rc, CMP_UNIQUE_ID notificationId);
    STDMETHODIMP FireCameraPictureRemovedEvent(CMPRESULT rc, CMP_UNIQUE_ID pictureId);
    STDMETHODIMP FireEventFilterChangedEvent(CMPRESULT rc, CMP_EVENT_ID eventId, INT16 filterFlags);
    STDMETHODIMP FirePickerControlStateChangedEvent(CMP_UNIQUE_ID controlId, INT16 pickerFlags, CMPRESULT result, INT16 selectedItemIndex);
    STDMETHODIMP FireViewportChangedEvent(CMPRESULT rc, INT16 flags, INT16 zoomFactor, CMP_DISPLAY_RECT* serverViewport, CMP_DISPLAY_RECT* clientViewport);

    STDMETHODIMP FirePictureCaptured(CMPRESULT rc, CMP_UNIQUE_LONG_ID uniqueId, BSTR pictureMetadata, BSTR filename, BSTR thumbnail, UINT32 pictureSize, CMP_CAPTURE_PICTURE_OPTIONS *options);
    STDMETHODIMP FireVideoCaptured(CMPRESULT rc, CMP_UNIQUE_LONG_ID uniqueId, BSTR videoMetadata, BSTR filename, UINT32 videoSize, CMP_CAPTURE_VIDEO_OPTIONS *options);
    STDMETHODIMP FireAudioCaptured(CMPRESULT rc, CMP_UNIQUE_LONG_ID uniqueId, BSTR audioMetadata, BSTR filename, UINT32 audioSize, CMP_CAPTURE_AUDIO_OPTIONS *options);

    STDMETHODIMP FireAppForeground();
    STDMETHODIMP FireAppBackground();
    STDMETHODIMP FireForegroundAppChanged(DWORD foregroundProcessId);

    STDMETHODIMP FireSupportedOrientationsChanged(CMPRESULT rc, CMP_SUPPORTED_ORIENTATIONS supportedOrientations);
    STDMETHODIMP FireCaptureMediaRemoved(CMPRESULT rc, CMP_UNIQUE_LONG_ID captureId);

    //IKeyboard
    STDMETHODIMP HideKeyboard(CMPRESULT* result);
    STDMETHODIMP ShowKeyboard(CMP_KEYBOARD_STATE *kybdState, CMPRESULT* result);
    STDMETHODIMP GetKeyboardState(CMP_KEYBOARD_STATE *kybdState, CMPRESULT* result);
    
    //IDisplay
    STDMETHODIMP GetOrientation(CMP_ORIENTATION_DATA *orientationData, CMPRESULT* result);
    STDMETHODIMP SetOrientation(CMP_ORIENTATION_POSITION orientation, INT16 orientationFlags, CMPRESULT* result);
    STDMETHODIMP GetScrollMode(CMP_SCROLL_MODE *scrollMode, CMPRESULT* result);
    STDMETHODIMP SetScrollMode(CMP_SCROLL_MODE scrollMode, CMPRESULT* result);
    STDMETHODIMP SetViewportOrigin(CMP_DISPLAY_POINT *pt, INT16 viewportFlags, CMPRESULT* result);
    STDMETHODIMP GetViewportOrigin(CMP_DISPLAY_POINT *pt, CMPRESULT* result);
    STDMETHODIMP GetDisplaySettings(CMP_DISPLAY_SETTINGS *dispSettings, CMPRESULT* result);
    STDMETHODIMP SetViewport(INT16 flags, INT16 zoomFactor, CMP_DISPLAY_RECT* serverViewport, CMPRESULT* result);
    STDMETHODIMP GetViewport(INT16* flags, INT16* zoomFactor, CMP_DISPLAY_RECT* serverViewport, 
                             CMP_DISPLAY_RECT* clientViewport, CMPRESULT* result);

    //ICamera
    STDMETHODIMP TakePicture(CMP_IMAGE_FORMAT imgType, CMP_UNIQUE_ID imageID, CMPRESULT* result);
    STDMETHODIMP GetPictureFilename(CMP_UNIQUE_ID pictureId, BSTR* filename, CMPRESULT* result);
    STDMETHODIMP GetPictureState(CMP_UNIQUE_ID pictureId, PINT32 size, CMP_PICTURE_STATE *pictState, CMPRESULT* result);
    STDMETHODIMP RemovePicture(CMP_UNIQUE_ID pictureId, CMPRESULT* result);

    //IPhone
    STDMETHODIMP StartPhoneCall(BSTR phoneNumber, CMP_UNIQUE_ID phoneCallId, CMPRESULT* result);

    //IMessage
    STDMETHODIMP SendSMS(BSTR phoneNumber, CMP_UNIQUE_ID messageId, BSTR SMSText, CMPRESULT* result);


    //IPicker
    STDMETHODIMP HidePicker(CMP_UNIQUE_ID controlID, CMPRESULT* result);
    STDMETHODIMP ShowPicker(CMP_UNIQUE_ID controlID, CMP_DISPLAY_RECT *rect, INT32 selectedIndex, 
                            BSTR listItems, BSTR title, CMPRESULT* result);

    STDMETHODIMP ShowPicker(CMP_UNIQUE_ID controlID, CMP_DISPLAY_RECT *rect, INT32 selectedIndex, 
                            SAFEARRAY **pickerText, BSTR pickerTitle, CMPRESULT* result);

    //IButton
    STDMETHODIMP SetButtonTarget(CMP_BUTTON_ID button, CMP_BUTTON_TARGET target, CMPRESULT* result);
    STDMETHODIMP GetButtonTarget(CMP_BUTTON_ID button, CMP_BUTTON_TARGET *target, CMPRESULT* result);

    STDMETHODIMP GetPickerState(CMP_UNIQUE_ID controlId, PINT16 pickerState, CMPRESULT* result);


    //IControl
    STDMETHODIMP EnableControls(CMPRESULT* result);
    STDMETHODIMP DisableControls(CMPRESULT* result);
    STDMETHODIMP GetControlsFlags(PINT16 controlFlags, CMPRESULT* result);

    //ICMPDevice
    STDMETHODIMP GetDevicePropertyBool(CMP_DEV_BOOL_PROP_ID propertyId, VARIANT_BOOL *value, CMPRESULT* result);
    STDMETHODIMP GetDevicePropertyString(CMP_DEV_STRING_PROP_ID propertyId, BSTR *string, CMPRESULT* result);

    //IEventFilter
    STDMETHODIMP FilterEvent(CMP_EVENT_ID eventId, INT16 filterFlags, CMPRESULT* result);

    //INotification
    STDMETHODIMP NotifyUser(CMP_UNIQUE_ID notificationId, INT16 notificationFlags, BSTR notificationText, CMPRESULT* result);

    //IVirtualDevice
    STDMETHODIMP OpenSessionForProcess(DWORD processId, CMPRESULT* result);

    //ICMPCapture
    STDMETHODIMP CapturePicture(CMP_CAPTURE_PICTURE_OPTIONS *options, CMP_UNIQUE_LONG_ID *uniqueId, CMPRESULT* result);
    STDMETHODIMP CaptureVideo(CMP_CAPTURE_VIDEO_OPTIONS *options, CMP_UNIQUE_LONG_ID *uniqueId, CMPRESULT* result);
    STDMETHODIMP CaptureAudio(CMP_CAPTURE_AUDIO_OPTIONS *options, CMP_UNIQUE_LONG_ID *uniqueId, CMPRESULT* result);
    STDMETHODIMP RemoveCapturedData(CMP_UNIQUE_LONG_ID uniqueId, CMPRESULT* result);

    //IOrientation
    STDMETHODIMP SetSupportedOrientations(CMP_SUPPORTED_ORIENTATIONS supportedOrientations, CMPRESULT* result);
    STDMETHODIMP GetSupportedOrientations(CMP_SUPPORTED_ORIENTATIONS *supportedOrientations, CMPRESULT* result);

private:
    STDMETHODIMP ConnectToSession(CMPRESULT* rc);

    ICMPAPI * _session;
    CritSec _sessionCS;
    bool _sessionactive;
    CMP_SESSION_STATE _sessionState;
    CMP_CHANNEL_STATE _channelState;
    CMPEvents* _eventHandler;
    HMODULE _hModVDO;
};