ImagePrint/ImagePrintEngine/DeviceProtocols/upnpprotocolfw2/inc/mpcpobserver.h
branchGCC_SURGE
changeset 25 59ea2209bb67
parent 23 08cc4cc059d4
parent 15 a92d00fca574
equal deleted inserted replaced
23:08cc4cc059d4 25:59ea2209bb67
     1 /*
       
     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Declares the MPCPObserver interface class
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPCPOBSERVER_H
       
    20 #define MPCPOBSERVER_H
       
    21 
       
    22 #include <e32def.h>
       
    23 #include <e32std.h>
       
    24 
       
    25 class CUpnpAction;
       
    26 class CUpnpService;
       
    27 class CUpnpDevice;
       
    28 class CUpnpHttpMessage;
       
    29 
       
    30 /**
       
    31 *  @brief A virtual MPCPObserver class.
       
    32 *
       
    33 *  @since Series60 3.1
       
    34 */
       
    35 class MPCPObserver
       
    36     {
       
    37     public: // New interface functions
       
    38 
       
    39         /**
       
    40     	* CreateJobResponse callback function
       
    41         * @since Series60 3.1
       
    42         * @param aAction the action
       
    43         * @param aErrorCode System wide error code
       
    44         */
       
    45         virtual void CreateJobResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    46 
       
    47         /**
       
    48     	* CancelJobResponse callback function
       
    49         * @since Series60 3.1
       
    50         * @param aAction the action
       
    51         * @param aErrorCode System wide error code
       
    52         */
       
    53         virtual void CancelJobResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    54 
       
    55         /**
       
    56     	* GetPrinterAttributesResponse callback function
       
    57         * @since Series60 3.1
       
    58         * @param aAction the action
       
    59         * @param aErrorCode System wide error code
       
    60         */
       
    61         virtual void GetPrinterAttributesResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    62 
       
    63         /**
       
    64     	* GetJobAttributesResponse callback function
       
    65         * @since Series60 3.1
       
    66         * @param aAction the action
       
    67         * @param aErrorCode System wide error code
       
    68         */
       
    69         virtual void GetJobAttributesResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    70 
       
    71         /**
       
    72     	* GetMarginsResponse callback function
       
    73         * @since Series60 3.1
       
    74         * @param aAction the action
       
    75         * @param aErrorCode System wide error code
       
    76         */
       
    77         virtual void GetMarginsResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    78 
       
    79         /**
       
    80     	* GetMediaListResponse callback function
       
    81         * @since Series60 3.1
       
    82         * @param aAction the action
       
    83         * @param aErrorCode System wide error code
       
    84         */
       
    85         virtual void GetMediaListResponse( CUpnpAction* aAction, TInt aErrorCode ) = 0;
       
    86 
       
    87 
       
    88         /**
       
    89     	* StateUpdatedResponse callback function
       
    90         * @since Series60 3.1
       
    91 		* @param	TDesC8& New printer state
       
    92 		* @param	TDesC8& Reason for the printer state		
       
    93 		* @param	TDesC8& List of job ids pending at the printer queue		
       
    94 		* @param	TDesC8& The end state of last printed job. Format: 
       
    95 		*					<id>,<name>,<originator>,<completed sheets>,<state>
       
    96 		* @param	TDesC8& Number of the printed sheets
       
    97 		* @param	TDesC8& The abort state of last aborted job. Format: 
       
    98 		*					<id>,<name>,<originator>,<completed sheets>,aborted,<reason>
       
    99 		* @param	TDesC8& Number of the sheets completedly received in printer
       
   100         */
       
   101         virtual void StateUpdatedResponse( const TDesC8& aPrinterState, 
       
   102                                            const TDesC8& aPrinterStateReasons, 
       
   103                                            const TDesC8& aJobIdList,
       
   104 	                                       const TDesC8& aJobEndState, 
       
   105                                            const TDesC8& aJobMediaSheetsCompleted, 
       
   106                                            const TDesC8& aJobAbortState,
       
   107                                            const TDesC8& aContentCompleteList ) = 0;
       
   108 
       
   109         /**
       
   110     	* DeviceDiscoveredL callback function
       
   111         * @since Series60 3.1
       
   112         * @param aDevice the device discovered
       
   113         */
       
   114         virtual void DeviceDiscoveredL( CUpnpDevice* aDevice ) = 0;
       
   115 
       
   116         /**
       
   117     	* DeviceDisappeared callback function
       
   118         * @since Series60 3.1
       
   119         * @param aDevice the device disappeared
       
   120         */
       
   121         virtual void DeviceDisappeared( CUpnpDevice* aDevice ) = 0;
       
   122 
       
   123 		/*
       
   124 		* @function		PrinterStateUpdated
       
   125 		* @description	Returns the state of the job after printer state updated 
       
   126 		* @param		TDesC8& New printer state
       
   127 		*/
       
   128 		virtual void PrinterStateUpdated( const TDesC8& aEvent ) = 0;
       
   129 		
       
   130 		/*
       
   131 		* @function		PrinterStateReasonsUpdated
       
   132 		* @description	Returns the state of the job after printer state reason updated 
       
   133 		* @param		TDesC8& Reason for the printer state		
       
   134 		*/
       
   135 		virtual void PrinterStateReasonsUpdated( const TDesC8& aEvent ) = 0;
       
   136 		
       
   137 		/*
       
   138 		* @function		JobIdListUpdated
       
   139 		* @description	Returns the state of the job after job ID list updated 
       
   140 		* @param		TDesC8& List of job ids pending at the printer queue		
       
   141 		*/
       
   142 		virtual void JobIdListUpdated( const TDesC8& aEvent ) = 0;
       
   143 
       
   144 		/*
       
   145 		* @function		JobEndStateUpdatedL
       
   146 		* @description	Returns the state of the job after job end state updated 
       
   147 		* @param		TDesC8& The end state of last printed job. Format: 
       
   148 		*						<id>,<name>,<originator>,<completed sheets>,<state>
       
   149 		*/
       
   150 		virtual void JobEndStateUpdated( const TDesC8& aEvent ) = 0;
       
   151 
       
   152 		/*
       
   153 		* @function		JobMediaSheetsCompletedUpdated
       
   154 		* @description	Returns the state of the job after media sheets completed list updated 
       
   155 		* @param		TDesC8& Number of the printed sheets
       
   156 		*/
       
   157 		virtual void JobMediaSheetsCompletedUpdated( const TDesC8& aEvent ) = 0;
       
   158 
       
   159 		/*
       
   160 		* @function		JobAbortStateUpdatedL
       
   161 		* @description	Returns the state of the job after job abort state updated 
       
   162 		* @param		TDesC8& The abort state of last aborted job. Format: 
       
   163 		*						<id>,<name>,<originator>,<completed sheets>,aborted,<reason>
       
   164 		*/
       
   165 		virtual void JobAbortStateUpdated( const TDesC8& aEvent ) = 0;
       
   166 
       
   167 		/*
       
   168 		* @function		ContentCompleteListUpdated
       
   169 		* @description	Returns the state of the job after content completed list updated 
       
   170 		* @param		TDesC8& Number of the sheets completedly received in printer
       
   171 		*/
       
   172 		virtual void ContentCompleteListUpdated( const TDesC8& aEvent ) = 0;
       
   173 
       
   174     };
       
   175 
       
   176 #endif // MPCPOBSERVER_H
       
   177 
       
   178 // End Of File