epoc32/include/mw/vwsdef.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1999-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:
    16 #ifndef __VWSDEF_H__
    16 #ifndef __VWSDEF_H__
    17 #define __VWSDEF_H__
    17 #define __VWSDEF_H__
    18 
    18 
    19 #include <e32std.h>
    19 #include <e32std.h>
    20 
    20 
       
    21 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    21 /**
    22 /**
    22 @publishedPartner
    23 @publishedPartner
       
    24 @released
    23 */
    25 */
    24 #define KUidCustomCrossCheckValue 0x80282748
    26 #define KUidCustomCrossCheckValue 0x80282748
    25 
    27 
    26 /**
    28 /**
    27 @publishedPartner
    29 @publishedPartner
       
    30 @released
    28 */
    31 */
    29 const TUid KUidCustomCrossCheck={KUidCustomCrossCheckValue};
    32 const TUid KUidCustomCrossCheck={KUidCustomCrossCheckValue};
       
    33 
       
    34 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
    30 
    35 
    31 class TVwsViewId
    36 class TVwsViewId
    32 /** Identifies an application view using two unique identifiers (UIDs): a view 
    37 /** Identifies an application view using two unique identifiers (UIDs): a view 
    33 UID and an application UID. 
    38 UID and an application UID. 
    34 
    39 
    53 	
    58 	
    54 	Uniquely identifies the view. */
    59 	Uniquely identifies the view. */
    55 	TUid iViewUid;
    60 	TUid iViewUid;
    56 	};
    61 	};
    57 
    62 
    58 /** @internalTechnology */
    63 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    64 /**
       
    65 @internalTechnology
       
    66 @released
       
    67 */
    59 #define KNullViewId TVwsViewId(KNullUid,KNullUid)
    68 #define KNullViewId TVwsViewId(KNullUid,KNullUid)
    60 
    69 
    61 /** @internalTechnology */
    70 /**
       
    71 @internalTechnology
       
    72 @released
       
    73 */
    62 const TInt KErrViewWrongMode=1; // !!! Wrong error code - should be -ve & unique
    74 const TInt KErrViewWrongMode=1; // !!! Wrong error code - should be -ve & unique
    63 
    75 
       
    76 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
    64 
    77 
    65 class TVwsViewIdAndMessage
    78 class TVwsViewIdAndMessage
    66 /**
    79 /**
    67 The TVwsViewIdAndMessage class identifies a view and encapsulates a message to
    80 The TVwsViewIdAndMessage class identifies a view and encapsulates a message to
    68 be read by the view when it is activated.
    81 be read by the view when it is activated.
    82 	TInt iCustomMessageLength;
    95 	TInt iCustomMessageLength;
    83 	TPtrC8 iCustomMessage;
    96 	TPtrC8 iCustomMessage;
    84 	};
    97 	};
    85 
    98 
    86 
    99 
    87 
   100 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    88 class TVwsViewEvent
   101 class TVwsViewEvent
    89 /**
   102 /**
    90 The TVwsViewEvent class encapsulates the attributes of a view server event.
   103 The TVwsViewEvent class encapsulates the attributes of a view server event.
    91 These are:
   104 These are:
    92 - The event type
   105 - The event type
   145 	To retrieve the message itself from the server, a buffer of this length must be allocated
   158 	To retrieve the message itself from the server, a buffer of this length must be allocated
   146 	*/
   159 	*/
   147 	TInt iCustomMessageLength;
   160 	TInt iCustomMessageLength;
   148 	};
   161 	};
   149 
   162 
   150 
       
   151 //
   163 //
   152 // Typedefs.
   164 // Typedefs.
   153 //
   165 //
   154 /** @internalComponent */
   166 /**
       
   167 @internalComponent
       
   168 @released
       
   169 */
   155 typedef TPckgBuf<TVwsViewIdAndMessage> TVwsViewIdAndMessageBuf;
   170 typedef TPckgBuf<TVwsViewIdAndMessage> TVwsViewIdAndMessageBuf;
   156 
   171 
   157 /** @internalComponent */
   172 /**
       
   173 @internalComponent
       
   174 @released
       
   175 */
   158 typedef TPckgBuf<TVwsViewEvent> TVwsViewEventBuf;
   176 typedef TPckgBuf<TVwsViewEvent> TVwsViewEventBuf;
   159 
   177 
       
   178 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
   160 
   179 
   161 //
   180 //
   162 // Inlines
   181 // Inlines
   163 //
   182 //
   164 
   183 
   257 	iCustomMessageLength=aVwsViewIdAndMessage.iCustomMessage.Length();
   276 	iCustomMessageLength=aVwsViewIdAndMessage.iCustomMessage.Length();
   258 	iCustomMessage.Set(aVwsViewIdAndMessage.iCustomMessage);
   277 	iCustomMessage.Set(aVwsViewIdAndMessage.iCustomMessage);
   259 	return(*this);
   278 	return(*this);
   260 	}
   279 	}
   261 
   280 
       
   281 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   282 
   262 inline TVwsViewEvent::TVwsViewEvent() {}
   283 inline TVwsViewEvent::TVwsViewEvent() {}
   263 
   284 
   264 inline TVwsViewEvent::TVwsViewEvent(TVwsViewEventType aEventType)
   285 inline TVwsViewEvent::TVwsViewEvent(TVwsViewEventType aEventType)
   265 	: iEventType(aEventType),iViewOneId(),iViewTwoId(),iCustomMessageId(KNullUid),iCustomMessageLength(0) {}
   286 	: iEventType(aEventType),iViewOneId(),iViewTwoId(),iCustomMessageId(KNullUid),iCustomMessageLength(0) {}
   266 
   287 
   271 	: iEventType(aEventType),iViewOneId(aViewOneId),iViewTwoId(aViewTwoId),iCustomMessageId(KNullUid),iCustomMessageLength(0) {}
   292 	: iEventType(aEventType),iViewOneId(aViewOneId),iViewTwoId(aViewTwoId),iCustomMessageId(KNullUid),iCustomMessageLength(0) {}
   272 
   293 
   273 inline TVwsViewEvent::TVwsViewEvent(TVwsViewEventType aEventType,const TVwsViewId& aViewOneId,const TVwsViewId& aViewTwoId,TUid aCustomMessageId,TInt aCustomMessageLength)
   294 inline TVwsViewEvent::TVwsViewEvent(TVwsViewEventType aEventType,const TVwsViewId& aViewOneId,const TVwsViewId& aViewTwoId,TUid aCustomMessageId,TInt aCustomMessageLength)
   274 	: iEventType(aEventType),iViewOneId(aViewOneId),iViewTwoId(aViewTwoId),iCustomMessageId(aCustomMessageId),iCustomMessageLength(aCustomMessageLength) {}
   295 	: iEventType(aEventType),iViewOneId(aViewOneId),iViewTwoId(aViewTwoId),iCustomMessageId(aCustomMessageId),iCustomMessageLength(aCustomMessageLength) {}
   275 
   296 
       
   297 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
   276 
   298 
   277 #endif
   299 #endif