dsdcmoadapter/inc/nsmldsctrldcmoadapter.h
changeset 0 dab8a81a92de
equal deleted inserted replaced
-1:000000000000 0:dab8a81a92de
       
     1 /*
       
     2 * Copyright (c) 2009 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:  header file for DSCtrl plug-in adapter
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef _NSMLDSCTRLDCMOADAPTER__
       
    19 #define _NSMLDSCTRLDCMOADAPTER__
       
    20 
       
    21 // Header needed for our CDCMO interface
       
    22 #include "dcmointerface.h"
       
    23 
       
    24 /** 
       
    25  * An implementation of the CDCMOInterface definition
       
    26  * Provides methods to read/write the properties of DCMO Plugin
       
    27  * @lib nsmldsctrldcmoadapter.dll
       
    28  */
       
    29 class CNsmlDsCtrlDCMOAdapter : public CDCMOInterface
       
    30 	{
       
    31 
       
    32 public:
       
    33 	/**
       
    34 	* Two phase construction
       
    35 	* Standardised safe construction which leaves nothing the cleanup stack.
       
    36     */
       
    37 	static CNsmlDsCtrlDCMOAdapter* NewL(TAny* aInitParams);
       
    38 	
       
    39 	/**
       
    40     * Destructor
       
    41     */
       
    42 	~CNsmlDsCtrlDCMOAdapter();
       
    43 
       
    44 	// Implementation of CDCMOInterface
       
    45 	
       
    46 	/**
       
    47     * Get DCMO Plug-in's attribute value which are integers
       
    48     * 
       
    49     * @param aId, it refer to the attributes of the capability
       
    50     * @param aValue, it refer to the value of the attribute to be fetched
       
    51     * @return status, It returns DCMO request success or failure
       
    52     */
       
    53 	TDCMOStatus  GetDCMOPluginIntAttributeValueL(TDCMONode aId, TInt& aValue);
       
    54 	
       
    55 	/**
       
    56     * Get DCMO Plug-in's attribute value which are strings
       
    57     * 
       
    58     * @param aId, it refer to the attributes of the capability
       
    59     * @param aValue, it refer to the value of the attribute to be fetched
       
    60     * @return status, It returns DCMO request success or failure
       
    61     */
       
    62 	TDCMOStatus  GetDCMOPluginStrAttributeValueL(TDCMONode aId, TDes& aStrValue);
       
    63 	
       
    64 	/**
       
    65     * Set DCMO Plug-in's attribute value which are integers
       
    66     * 
       
    67     * @param aId, it refer to the attributes of the capability
       
    68     * @param aValue, it refer to the value of the attribute to be set
       
    69     * @return status, It returns DCMO request success or failure
       
    70     */
       
    71 	TDCMOStatus  SetDCMOPluginIntAttributeValueL(TDCMONode aId, TInt aValue);
       
    72 	
       
    73 	/**
       
    74     * Set DCMO Plug-in's attribute value which are strings
       
    75     * 
       
    76     * @param aId, it refer to the attributes of the capability
       
    77     * @param aValue, it refer to the value of the attribute to be set
       
    78     * @return status, It returns DCMO request success or failure
       
    79     */
       
    80 	TDCMOStatus  SetDCMOPluginStrAttributeValueL(TDCMONode aId, const TDes& aStrValue);
       
    81 	
       
    82 	/**
       
    83     * Get localised name of the Plug-in
       
    84     * 
       
    85     * @param aLocName, member to store the name of Plugin
       
    86     */
       
    87 	void GetLocalizedNameL (HBufC*& aLocName);    
       
    88 	
       
    89 private:
       
    90 	/**
       
    91     * Construction
       
    92     */
       
    93     CNsmlDsCtrlDCMOAdapter(TAny* aInitParams);
       
    94   
       
    95     /**
       
    96 	* Second Phase constructor
       
    97 	*/
       
    98 	void ConstructL();
       
    99 
       
   100 private:
       
   101 	// Data to pass back from implementation to client
       
   102 	
       
   103 	/**
       
   104 	* Member to store the Property Attribute of the Plug-in
       
   105 	* It will be sent back to the client
       
   106 	*/
       
   107 	HBufC* iProperty;
       
   108 	
       
   109 	/**
       
   110 	* Member to store the Description Attribute of the Plug-in
       
   111 	* It will be sent back to the client
       
   112 	*/
       
   113 	HBufC* iDescription;
       
   114 	
       
   115 	/**
       
   116 	* Parameters taken from client
       
   117 	*/
       
   118 	TDCMOInterfaceInitParams* iInitParams;
       
   119 	};  
       
   120 
       
   121 #endif //_NSMLDSCTRLDCMOADAPTER__