2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0/
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FUiAccessibilityElement.h
20 * @brief This is the header file for the AccessibilityElement class.
22 * This header file contains the declarations of the AccessibilityElement class.
26 #ifndef _FUI_ACCESSIBILITY_ELEMENT_H_
27 #define _FUI_ACCESSIBILITY_ELEMENT_H_
29 #include <FOspConfig.h>
30 #include <FBaseObject.h>
31 #include <FUiAccessibilityTypes.h>
33 namespace Tizen { namespace Base
38 namespace Tizen { namespace Graphics
44 namespace Tizen { namespace Ui
46 class _AccessibilityElementImpl;
49 * @class AccessibilityElement
50 * @brief This class represents an accessibility element.
53 * @final This class is not intended for extension.
55 * This class represents an accessibility element.
57 class _OSP_EXPORT_ AccessibilityElement
58 : public Tizen::Base::Object
62 * The object is not fully constructed after this constructor is called. @n
63 * For full construction, the Construct() method must be called right after calling this constructor.
67 AccessibilityElement(void);
70 * This destructor overrides Tizen::Base::Object::~Object().
74 virtual ~AccessibilityElement(void);
77 * Initializes the instance of %AccessibilityElement with the specified parameters.
81 * @return An error code
82 * @param[in] bounds The bounds of the accessibility element
83 * @param[in] name The name of the accessibility element
84 * @exception E_SUCCESS The method is successful.
85 * @exception E_INVALID_ARG Either the length of name parameter is @c 0, or the bounds are smaller than @c 0.
87 result Construct(const Tizen::Graphics::Rectangle& bounds, const Tizen::Base::String& name);
90 * Initializes this instance of %AccessibilityElement with specified parameters.
94 * @return An error code
95 * @param[in] bounds The bounds of the accessibility element
96 * @param[in] name The name of the accessibility element
97 * @exception E_SUCCESS The method is successful.
98 * @exception E_INVALID_ARG Either the length of @c name parameter is @c 0, or the @c bounds are smaller than @c 0.
100 result Construct(const Tizen::Graphics::FloatRectangle& bounds, const Tizen::Base::String& name);
103 * Gets the name of the element.
106 * @return The name of the element
108 Tizen::Base::String GetName(void) const;
111 * Sets the bounds to the element.
114 * @param[in] bounds The bounds of the accessibility element
116 void SetBounds(const Tizen::Graphics::Rectangle& bounds);
119 * Sets the bounds of an element.
122 * @param[in] bounds The bounds of the accessibility element
124 void SetBounds(const Tizen::Graphics::FloatRectangle& bounds);
127 * Gets the bounds of the element.
130 * @return The bounds of the element
132 Tizen::Graphics::Rectangle GetBounds(void) const;
135 * Gets the bounds of an element.
138 * @return The bounds of the element
140 Tizen::Graphics::FloatRectangle GetBoundsF(void) const;
143 * Sets the label to the element.
146 * @param[in] label The label of the accessibility element
148 void SetLabel(const Tizen::Base::String& label);
151 * Gets the label of the element.
154 * @return The label of the element
156 Tizen::Base::String GetLabel(void) const;
159 * Sets the hint to the element.
162 * @param[in] hint The hint of the accessibility element
164 void SetHint(const Tizen::Base::String& hint);
167 * Gets the hint of the element.
170 * @return The hint of the element
172 Tizen::Base::String GetHint(void) const;
175 * Sets the trait to the element.
178 * @param[in] trait The trait of the accessibility element
180 void SetTrait(const Tizen::Base::String& trait);
184 * Gets the trait of the element.
187 * @return The trait of the element
189 Tizen::Base::String GetTrait(void) const;
192 * Sets the value to the element.
195 * @param[in] value The value of the accessibility element
197 void SetValue(const Tizen::Base::String& value);
200 * Gets the value of the element.
203 * @return The value of the element
205 Tizen::Base::String GetValue(void) const;
209 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
211 AccessibilityElement(const AccessibilityElement& rhs);
214 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
216 AccessibilityElement& operator =(const AccessibilityElement& rhs);
219 friend class _AccessibilityElementImpl;
220 _AccessibilityElementImpl* __pAccessibilityElementImpl;
221 }; // AccessibilityElement
224 #endif //_FUI_ACCESSIBILITY_ELEMENT_H_