examples/contact-cards/contact-card-layouter.h

   1 #ifndef CONTACT_CARD_LAYOUTER_H
   2 #define CONTACT_CARD_LAYOUTER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/adaptor-framework/window.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24 #include <dali/public-api/math/vector2.h>
  25 #include <string>
  26 #include <vector>
  27
  28 // INTERNAL INCLUDES
  29 #include "contact-card-layout-info.h"
  30
  31 class ContactCard;
  32
  33 /**
  34  * @brief This class lays out contact cards on the screen appropriately.
  35  *
  36  * The contact cards are added to the passed in window directly and it uses the window size to figure out exactly how to layout them.
  37  * It supports a minimum of 3 items on each row or column.
  38  *
  39  * Relayouting is not supported.
  40  */
  41 class ContactCardLayouter
  42 {
  43 public:
  44   /**
  45    * @brief Constructor.
  46    */
  47   ContactCardLayouter();
  48
  49   /**
  50    * @brief Destructor.
  51    */
  52   ~ContactCardLayouter();
  53
  54   /**
  55    * @brief Creates a contact card with the given information.
  56    * @param[in]  window          The window to add the contact to.
  57    * @param[in]  contactName     The name of the contact to display.
  58    * @param[in]  contactAddress  The address of the contact to display.
  59    * @param[in]  imagePath       The path to the image to display.
  60    */
  61   void AddContact(Dali::Window window, const std::string& contactName, const std::string& contactAddress, const std::string& imagePath);
  62
  63 private:
  64   /**
  65    * @brief Calculates the next position of the contact card that's about to be added to our container.
  66    * @return A reference to the next position.
  67    */
  68   const Dali::Vector2& NextCardPosition();
  69
  70   ContactCardLayoutInfo mContactCardLayoutInfo; ///< The common layouting information used by all contact cards. Set up when AddContact is first called.
  71
  72   typedef Dali::IntrusivePtr<ContactCard> ContactCardPtr; ///< Better than raw pointers as these are ref counted and the memory is released when the count reduces to 0.
  73   typedef std::vector<ContactCardPtr>     ContactCardContainer;
  74   ContactCardContainer                    mContactCards; ///< Contains all the contact cards.
  75
  76   Dali::Vector2 mLastPosition;        ///< The last position a contact card was added.
  77   Dali::Vector2 mPositionIncrementer; ///< Calculated once when AddContact is first called.
  78   size_t        mItemsPerRow;         ///< Calculated once when AddContact is first called and stores the number of items we have in a row.
  79
  80   bool mInitialized; ///< Whether initialization has taken place or not.
  81 };
  82
  83 #endif // CONTACT_CARD_LAYOUTER_H