example/clientapi/smf/inc/common/smfmusic/smfevent.h
changeset 1 4b1e636e8a71
equal deleted inserted replaced
0:5d2360e70d9f 1:4b1e636e8a71
       
     1 /**
       
     2  * @file	smfevent.h
       
     3  * @author  Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution
       
     4  * @version 1.0
       
     5  *
       
     6  * @section LICENSE
       
     7  *
       
     8  * Copyright (c) 2010 Sasken Communication Technologies Ltd. 
       
     9  * All rights reserved.
       
    10  * This component and the accompanying materials are made available 
       
    11  * under the terms of the "{License}" 
       
    12  * which accompanies  this distribution, and is available 
       
    13  * at the URL "{LicenseUrl}".
       
    14  * 
       
    15  * @section DESCRIPTION
       
    16  *
       
    17  * The event class represents a music event
       
    18  */
       
    19 
       
    20 #ifndef SMFEVENT_H_
       
    21 #define SMFEVENT_H_
       
    22 
       
    23 #include <smfvenue.h>
       
    24 #include <QStringList>
       
    25 #include <qdatastream.h>
       
    26 #include "SmfClientGlobal.h"
       
    27 /**
       
    28  * The event class represents a music event
       
    29  */
       
    30 class SMFCLIENT_EXPORT SmfEvent : public QObject
       
    31 	{
       
    32 	Q_OBJECT
       
    33 public:
       
    34 	/**
       
    35 	 * Constructor with default argument
       
    36 	 * @param aParent The parent object
       
    37 	 */
       
    38 	SmfEvent( QObject *aParent = 0 );
       
    39 	
       
    40 	/**
       
    41 	 * Destructor
       
    42 	 */
       
    43 	~SmfEvent( );
       
    44 	
       
    45 	/**
       
    46 	 * Method to get the event name
       
    47 	 * @param aName The event name
       
    48 	 */
       
    49 	void getTitle( QString &aName );
       
    50 	
       
    51 	/**
       
    52 	 * Method to get the event date and time
       
    53 	 */
       
    54 	void getEventDateTime( QDateTime &aDateTime );
       
    55 	
       
    56 	/**
       
    57 	 * Method to get the artist names
       
    58 	 * @param aArtist The list of artists in the event
       
    59 	 */
       
    60 	void getArtists( QStringList &aArtist );
       
    61 	
       
    62 	/**
       
    63 	 * Method to get the venue of the event
       
    64 	 * @param aVenue The venue of the event
       
    65 	 */
       
    66 	void getVenue( SmfVenue &aVenue );
       
    67 	
       
    68 	/**
       
    69 	 * Method to get the URL for getting tickets for the event
       
    70 	 * @param aUrl The Url for getting ticket for the event
       
    71 	 */
       
    72 	void getTicketUrl( QUrl &aUrl );
       
    73 	
       
    74 	/**
       
    75 	 * Method to get the id of the event
       
    76 	 * @param aId The ID value 
       
    77 	 */
       
    78 	void getId( QString &aId );
       
    79 	
       
    80 	/**
       
    81 	 * Method to set the event name
       
    82 	 * @param aName The new event name
       
    83 	 */
       
    84 	void setTitle( const QString& aName );
       
    85 	
       
    86 	/**
       
    87 	 * Method to set the event date and time
       
    88 	 * @param aDateTime The new date and time of the event
       
    89 	 * 
       
    90 	 */
       
    91 	void setEventDateTime( const QDateTime& aDateTime );
       
    92 	
       
    93 	/**
       
    94 	 * Method to set the artist names
       
    95 	 * @param aArtist The new list of artists in the event
       
    96 	 */
       
    97 	void setArtists( const QStringList& aArtist );
       
    98 	
       
    99 	/**
       
   100 	 * Method to set the venue name
       
   101 	 * @param aVenue The new venue of the event
       
   102 	 */
       
   103 	void setVenue( const SmfVenue& aVenue );
       
   104 	
       
   105 	/**
       
   106 	 * Method to set the URL for getting tickets for the event
       
   107 	 * @param aUrl The new Url for getting ticket for the event
       
   108 	 */
       
   109 	void setTicketUrl( const QUrl &aUrl );
       
   110 
       
   111 private:
       
   112 	QStringList m_name;			// event name
       
   113 	QDateTime 	m_dateTime;		// event date and time
       
   114 	QStringList m_artistName;	// event artist names
       
   115 	SmfVenue 	m_venue;		// venue of the event
       
   116 	QUrl 		m_url;			// ticket url
       
   117 	QString 	m_eventId;
       
   118 	
       
   119 	};
       
   120 /**
       
   121 * Externalization
       
   122 */
       
   123 QDataStream &operator<<(QDataStream &, const SmfEvent&);
       
   124 /**
       
   125  * Internalization
       
   126  */
       
   127 QDataStream &operator>>(QDataStream &, SmfEvent&);
       
   128 
       
   129 #endif /* SMFEVENT_H_ */