src/ui/inc/FUi_AccessibilityElement.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.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
   8 //
   9 //     http://floralicense.org/license/
  10 //
  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.
  16 //
  17
  18 /**
  19  * @file        FUi_AccessibilityElement.h
  20  * @brief       This is the header file for the _AccessibilityElement class.
  21  *
  22  * This header file contains the declarations of the _AccessibilityElement class.
  23  *
  24  */
  25 #ifndef _FUI_INTERNAL_ACCESSIBILITY_ELEMENT_H_
  26 #define _FUI_INTERNAL_ACCESSIBILITY_ELEMENT_H_
  27
  28 #include <FBaseString.h>
  29 #include <FGrpRectangle.h>
  30 #include <FUi_AccessibilityContainer.h>
  31
  32 namespace Tizen { namespace Ui {
  33
  34 class _AccessibilityContainer;
  35 class _AccessibilityElementImpl;
  36
  37 class _AccessibilityElement
  38 {
  39
  40 public:
  41         _AccessibilityElement(bool systemElement = false);
  42         virtual ~_AccessibilityElement(void);
  43         result Construct(const Tizen::Base::String& name, const Tizen::Graphics::Rectangle& bounds);
  44         void SetBounds(const Tizen::Graphics::Rectangle& bounds);
  45         Tizen::Graphics::Rectangle GetBounds(void) const;
  46         Tizen::Graphics::Rectangle GetAbsoluteBounds(void) const;
  47         void SetName(const Tizen::Base::String& name);
  48         Tizen::Base::String GetName(void) const;
  49         void SetLabel(const Tizen::Base::String& label);
  50         Tizen::Base::String GetLabel(void) const;
  51         void SetHint(const Tizen::Base::String& hint);
  52         Tizen::Base::String GetHint(void) const;
  53         void SetStatus(const Tizen::Base::String& guide);
  54         Tizen::Base::String GetStatus(void) const;
  55         void SetTrait(AccessibilityTraits trait);
  56         AccessibilityTraits GetTrait(void) const;
  57         void SetTrait(const Tizen::Base::String& trait);
  58         Tizen::Base::String GetTraitString(void) const;
  59         void SetValue(const Tizen::Base::String& value);
  60         Tizen::Base::String GetValue(void) const;
  61         void Activate(bool enable);
  62         bool IsActivated(void) const;
  63         void SetParent(const _AccessibilityContainer& parent);
  64         _AccessibilityContainer* GetParent(void) const;
  65         void SetUserData(void* pUserData);
  66         void* GetUserData(void) const;
  67
  68         void SetSupportOperatingGesture(bool set);
  69         bool GetSupportOperatingGesture(void);
  70
  71         Tizen::Base::String GetReadingContents(void) const;
  72         bool IsSystemElement(void);
  73
  74 private:
  75         _AccessibilityElement(const _AccessibilityElement& rhs);
  76         _AccessibilityElement& operator =(const _AccessibilityElement& rhs);
  77
  78 private:
  79         Tizen::Base::String __name;
  80         Tizen::Graphics::Rectangle __bounds;
  81         Tizen::Graphics::Rectangle __absBounds;
  82         Tizen::Base::String __label;
  83         Tizen::Base::String __hint;
  84         Tizen::Base::String __status;
  85         Tizen::Base::String __traitString;
  86         AccessibilityTraits __trait;
  87         Tizen::Base::String __value;
  88         _AccessibilityContainer* __pParent;
  89         void* __pUserData;
  90         bool __systemElement;
  91         bool __activated;
  92         bool __supportOperatingGesture;
  93 };
  94 }}
  95 #endif //_FUI_INTERNAL_ACCESSIBILITY_ELEMENT_H_