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