inc/PhnDialContactInfo.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Flora License, Version 1.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://floralicense.org/license/
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an AS IS BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                PhnDialContactInfo.h
  19  * @brief               This is the header file for the %DialContactInfo class.
  20  *
  21  * This header file contains the declarations for %DialContactInfo class.
  22  */
  23 #ifndef _PHN_DIAL_CONTACT_INFO_H_
  24 #define _PHN_DIAL_CONTACT_INFO_H_
  25
  26 #include <FSocial.h>
  27
  28 /**
  29  * @class DialContactInfo
  30  * @brief This is a light-weight class used to provides display name,
  31  * phone number and Thumbnail using simple methods.
  32  *
  33  */
  34 class DialContactInfo: public Tizen::Base::Object
  35 {
  36 public:
  37         DialContactInfo(void);
  38         virtual ~DialContactInfo(void);
  39         /*
  40         //Used to create new 'DialContactInfo' object which is clone of 'this' object.
  41         DialContactInfo* CloneN(void);
  42         */
  43         //display name
  44         void SetDisplayName(Tizen::Base::String& pDisplayName);
  45         Tizen::Base::String& GetDisplayName(void) const;
  46         //phone number
  47         void SetPhoneNumber(Tizen::Base::String& pPhoneNumber);
  48         Tizen::Base::String& GetPhoneNumber(void) const;
  49         //matched search string
  50         void AddSearchKey(Tizen::Base::String& pSearchString);
  51         void RemoveSearchKey(int index);
  52         void ReplaceSearchKey(int index, Tizen::Base::String& pSearchString);
  53         //Used to get the first matched search key
  54         Tizen::Base::String* GetSearchKey(void);
  55         Tizen::Base::Collection::IList* GetSearchKeyList(void);
  56         //Used to transfer ownership of 'pBitmap' to 'DialContactInfo'.
  57         void SetThumbnail(Tizen::Graphics::Bitmap* pBitmap);
  58         Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
  59         //Coll Log Db Id
  60         void SetCallLogDbId(int callLogDbId);
  61         int GetCallLogDbId(void);
  62         //Checks whether the value of the specified instance is equal to the value of the current instance of %Object.
  63         virtual bool Equals(const Object& obj) const;
  64         /**
  65          * Used to return new 'DialContactInfo' object with the same state
  66          * as the object on which this function is called.
  67          */
  68         DialContactInfo* CloneN(void);
  69
  70 private:
  71         //Copy Constructor - we dont want any bitwise copy.
  72         DialContactInfo(const DialContactInfo& obj);
  73
  74 private:
  75         int __callLogDbId;
  76         Tizen::Base::String* __pDisplayName;
  77         Tizen::Base::String* __pPhoneNumber;
  78         Tizen::Graphics::Bitmap* __pThumbnail;
  79         Tizen::Base::Collection::ArrayList*  __pSearchKeyList;
  80 };
  81
  82 #endif // _PHN_DIAL_CONTACT_INFO_H_