base/dali-toolkit/public-api/controls/default-controls/check-button-factory.h

   1 #ifndef __DALI_TOOLKIT_CHECK_BUTTON_FACTORY_H__
   2 #define __DALI_TOOLKIT_CHECK_BUTTON_FACTORY_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22 #include <dali-toolkit/public-api/controls/buttons/check-box-button.h>
  23
  24 namespace Dali DALI_IMPORT_API
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * Creates a check box button with the given images.
  32  * Images will be shrunk to fit the button size keeping their aspect ratio.
  33  * @note Images won't be scaled to fill the whole button size.
  34  * @note If an image path is empty, this image is not set to the button.
  35  *
  36  * @param[in] backgroundImagePath Image path to be shown as button background.
  37  * @param[in] checkedImagePath Image path to be shown as checked button.
  38  * @param[in] dimmedBackgroundImagePath Image path to be shown as button dimmed background.
  39  * @param[in] dimmedCheckedImagePath Image path to be shown as dimmed checked button.
  40  */
  41 CheckBoxButton CreateCheckBoxButton( const std::string& backgroundImagePath, const std::string& checkedImagePath, const std::string& dimmedBackgroundImagePath, const std::string& dimmedCheckedImagePath );
  42
  43 /**
  44  * Creates a check box button with the given images.
  45  * Images will be shrunk to fit the button size keeping their aspect ratio.
  46  * @note Images won't be scaled to fill the whole button size.
  47  * @note If an image is an empty handle, this image is not set to the button.
  48  *
  49  * @param[in] backgroundImageActor  Image to be shown as button background.
  50  * @param[in] checkedImageActor  Image to be shown as checked button.
  51  * @param[in] dimmedBackgroundImageActor Image to be shown as button dimmed background.
  52  * @param[in] dimmedCheckedImagActor Image to be shown as dimmed checked button.
  53  */
  54 CheckBoxButton CreateCheckBoxButton( Actor backgroundImageActor, Actor checkedImageActor, Actor dimmedBackgroundImageActor, Actor dimmedCheckedImagActor );
  55
  56 /**
  57  * Creates a check box button with the given background and checked images.
  58  * Background and checked images will be shrunk to fit the button size keeping their aspect ratio.
  59  * @note Background and checked images won't be scaled to fill the whole button size.
  60  *
  61  * @param[in] backgroundImagePath  Image path to be shown as button background.
  62  * @param[in] checkedImagePath  Image path to be shown as checked button.
  63  */
  64 CheckBoxButton CreateCheckBoxButton( const std::string& backgroundImagePath, const std::string& checkedImagePath );
  65
  66 /**
  67  * Creates a check box button with the given background and checked images.
  68  * Background and checked images will be shrunk to fit the button size keeping their aspect ratio.
  69  * @note Background and checked images won't be scaled to fill the whole button size.
  70  *
  71  * @param[in] backgroundImageActor  Image to be shown as button background.
  72  * @param[in] checkedImageActor  Image to be shown as checked button.
  73  */
  74 CheckBoxButton CreateCheckBoxButton( Actor backgroundImageActor, Actor checkedImageActor );
  75 } // namespace Toolkit
  76
  77 } // namespace Dali
  78
  79 #endif // __DALI_TOOLKIT_CHECK_BUTTON_FACTORY_H__