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-toolkit/public-api/controls/buttons/check-box-button.h>
  23
  24 namespace Dali
  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] selectedImagePath Image path to be shown as selected button.
  38  * @param[in] disabledBackgroundImagePath Image path to be shown as button isabled background.
  39  * @param[in] disabledSelectedImagePath Image path to be shown as disabled selected button.
  40  */
  41 DALI_IMPORT_API CheckBoxButton CreateCheckBoxButton( const std::string& backgroundImagePath, const std::string& selectedImagePath, const std::string& disabledBackgroundImagePath, const std::string& disabledSelectedImagePath );
  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] selectedImageActor  Image to be shown as selected button.
  51  * @param[in] disabledBackgroundImageActor Image to be shown as button disabled background.
  52  * @param[in] disabledSelectedImagActor Image to be shown as disabled selected button.
  53  */
  54 DALI_IMPORT_API CheckBoxButton CreateCheckBoxButton( Actor backgroundImageActor, Actor selectedImageActor, Actor disabledBackgroundImageActor, Actor disabledSelectedImagActor );
  55
  56 /**
  57  * Creates a check box button with the given background and selected images.
  58  * Background and selected images will be shrunk to fit the button size keeping their aspect ratio.
  59  * @note Background and selected 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] selectedImagePath  Image path to be shown as selected button.
  63  */
  64 DALI_IMPORT_API CheckBoxButton CreateCheckBoxButton( const std::string& backgroundImagePath, const std::string& selectedImagePath );
  65
  66 /**
  67  * Creates a check box button with the given background and selected images.
  68  * Background and selected images will be shrunk to fit the button size keeping their aspect ratio.
  69  * @note Background and selected 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] selectedImageActor  Image to be shown as selected button.
  73  */
  74 DALI_IMPORT_API CheckBoxButton CreateCheckBoxButton( Actor backgroundImageActor, Actor selectedImageActor );
  75
  76 } // namespace Toolkit
  77
  78 } // namespace Dali
  79
  80 #endif // __DALI_TOOLKIT_CHECK_BUTTON_FACTORY_H__