epoc32/include/mw/uikon/eikalsrv.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    12 //
    12 //
    13 // Description:
    13 // Description:
    14 //
    14 //
    15 
    15 
    16 
       
    17 
       
    18 /**
    16 /**
    19  @file
    17  @file
    20  @internalComponent
    18  @publishedPartner
       
    19  WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases.
    21 */
    20 */
    22 
    21 
    23 #ifndef __EIKALSRV_H__
    22 #ifndef __EIKALSRV_H__
    24 #define __EIKALSRV_H__
    23 #define __EIKALSRV_H__
    25 
    24 
    30 class MEikServAlarmFactory;
    29 class MEikServAlarmFactory;
    31 class MEikServAlarm;
    30 class MEikServAlarm;
    32 class CEikServAlarmAlertSession;
    31 class CEikServAlarmAlertSession;
    33 
    32 
    34 /** 
    33 /** 
    35 @internalComponent
    34 @publishedPartner
       
    35 WARNING: Class for internal use ONLY. Compatibility is not guaranteed in future releases.
    36 */
    36 */
    37 NONSHARABLE_CLASS(CEikServAlarmAlertServer) : public CPolicyServer
    37 NONSHARABLE_CLASS(CEikServAlarmAlertServer) : public CPolicyServer
    38 	{
    38 	{
    39 public:
    39 public:
    40 	IMPORT_C static CEikServAlarmAlertServer* NewL(MEikServAlarmFactory* aAlarmControlFactory);
    40 	IMPORT_C static CEikServAlarmAlertServer* NewL(MEikServAlarmFactory* aAlarmControlFactory);
    59 
    59 
    60 class CEikAlmControlSupervisor;
    60 class CEikAlmControlSupervisor;
    61 
    61 
    62 /** 
    62 /** 
    63 Helper class for CEikServAlarmAlertSession. Holds response data for queuing
    63 Helper class for CEikServAlarmAlertSession. Holds response data for queuing
    64 @internalComponent
    64 @publishedPartner
       
    65 WARNING: Class for internal use ONLY. Compatibility is not guaranteed in future releases.
    65 */
    66 */
    66 NONSHARABLE_CLASS(TAlarmResponse)
    67 NONSHARABLE_CLASS(TAlarmResponse)
    67 	{
    68 	{
    68 public:	
    69 public:	
    69 	TAlarmResponse (TASAltAlertServerResponse  aCode,  TAlarmId aId, TTime aTime);
    70 	TAlarmResponse (TASAltAlertServerResponse  aCode,  TAlarmId aId, TTime aTime);
    80 // for response as soon	as it receive previous 
    81 // for response as soon	as it receive previous 
    81 const TInt KAlertResponseQueueSize = 20;	
    82 const TInt KAlertResponseQueueSize = 20;	
    82 
    83 
    83 /**
    84 /**
    84 Represents a session for a client thread on the server-side.
    85 Represents a session for a client thread on the server-side.
    85 @internalComponent 
    86 @publishedPartner
       
    87 WARNING: Class for internal use ONLY. Compatibility is not guaranteed in future releases. 
    86 */
    88 */
    87 NONSHARABLE_CLASS(CEikServAlarmAlertSession) : public CSession2
    89 NONSHARABLE_CLASS(CEikServAlarmAlertSession) : public CSession2
    88 	{
    90 	{
    89 public:
    91 public:
    90 	static CEikServAlarmAlertSession* NewL(MEikServAlarmFactory& aAlarmControlFactory, TInt aMaxAlarms);
    92 	static CEikServAlarmAlertSession* NewL(MEikServAlarmFactory& aAlarmControlFactory, TInt aMaxAlarms);
   116 	RPointerArray<CEikAlmControlSupervisor> iAlarmSupervisors;
   118 	RPointerArray<CEikAlmControlSupervisor> iAlarmSupervisors;
   117 	RArray <TAlarmResponse> iResponseQueue;
   119 	RArray <TAlarmResponse> iResponseQueue;
   118 	RMessage2 iMessage;
   120 	RMessage2 iMessage;
   119 	};
   121 	};
   120 
   122 
       
   123 /** WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.*/
   121 inline TBool CEikServAlarmAlertServer::AlarmAlertIsVisible() const 
   124 inline TBool CEikServAlarmAlertServer::AlarmAlertIsVisible() const 
   122 	{ return iSession->AlarmAlertIsVisible(); }
   125 	{ return iSession->AlarmAlertIsVisible(); }
   123 
   126 
       
   127 /** WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.*/
   124 inline TBool CEikServAlarmAlertSession::AlarmAlertIsVisible() const 
   128 inline TBool CEikServAlarmAlertSession::AlarmAlertIsVisible() const 
   125 	{ return iVisible; }
   129 	{ return iVisible; }
   126 
   130 
       
   131 /** WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.*/
   127 inline void CEikServAlarmAlertServer::SessionDied() 
   132 inline void CEikServAlarmAlertServer::SessionDied() 
   128 	{ iSession = NULL; }
   133 	{ iSession = NULL; }
   129 
   134 
       
   135 /** WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.*/
   130 inline TTime CEikServAlarmAlertSession::QuietPeriodEndTime() const 
   136 inline TTime CEikServAlarmAlertSession::QuietPeriodEndTime() const 
   131 	{ return iQuietPeriodEndTime; }
   137 	{ return iQuietPeriodEndTime; }
   132 
   138 
   133 #endif //__EIKALSRV_H__
   139 #endif //__EIKALSRV_H__