capi/dali-toolkit/public-api/controls/default-controls/solid-color-actor.h

   1 #ifndef __DALI_TOOLKIT_SOLID_COLOR_ACTOR_H__
   2 #define __DALI_TOOLKIT_SOLID_COLOR_ACTOR_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 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/math/vector4.h>
  28 #include <dali/public-api/actors/image-actor.h>
  29
  30 namespace Dali DALI_IMPORT_API
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 /**
  37  * @brief Creates a Dali::ImageActor with a solid color, optionally it creates a border.
  38  *
  39  * If the \e border parameter is set to \e true, the Dali::ImageActor's style is set to Dali::ImageActor::STYLE_NINE_PATCH.
  40  *
  41  * @param[in] color The ImageActor's color.
  42  * @param[in] border If \e true, a border is created. By default, the value is set to \e false.
  43  * @param[in] borderColor The color for the ImageActor's border. By default, the value is set to Color::WHITE.
  44  * @param[in] borderSize The size for the ImageActor's border. By default, the value is set to 1 pixel. It supports under 10 pixel for clear result of gl blend
  45  * @return a handle to the new ImageActor
  46  */
  47 ImageActor CreateSolidColorActor( const Vector4& color, bool border = false, const Vector4& borderColor = Color::WHITE, const unsigned int borderSize = 1 );
  48
  49
  50 } // namespace Toolkit
  51
  52 } // namespace Dali
  53
  54 /**
  55  * @}
  56  */
  57 #endif // __DALI_TOOLKIT_SOLID_COLOR_ACTOR_H__