summaryrefslogtreecommitdiff
path: root/dali/internal/accessibility/bridge/bridge-component.h
blob: 78a0459225c7d5c001a913aa6ccd5c91a96e840c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_COMPONENT_H
#define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_COMPONENT_H

/*
 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

// EXTERNAL INCLUDES
#include <array>
#include <string>
#include <tuple>
#include <unordered_map>
#include <vector>

// INTERNAL INCLUDES
#include <dali/devel-api/atspi-interfaces/component.h>
#include <dali/internal/accessibility/bridge/bridge-base.h>

/**
 * @brief The BridgeComponent class is to correspond with Dali::Accessibility::Component.
 */
class BridgeComponent : public virtual BridgeBase
{
  /**
   * @brief Returns the Component object of the currently executed DBus method call.
   *
   * @return The Component object
   */
  Dali::Accessibility::Component* FindSelf() const;

public:
  explicit BridgeComponent(std::shared_ptr<BridgeData> bridgeData);

  /**
   * @brief Gets dbus interface description for Component type.
   */
  DBus::DBusInterfaceDescription GetInterfaces() override;

  /**
   * @copydoc Dali::Accessibility::Component::IsAccessibleContainingPoint()
   */
  DBus::ValueOrError<bool> IsAccessibleContainingPoint(int32_t x, int32_t y, uint32_t coordType);

  /**
   * @copydoc Dali::Accessibility::Component::GetAccessibleAtPoint()
   */
  DBus::ValueOrError<Dali::Accessibility::Accessible*> GetAccessibleAtPoint(int32_t x, int32_t y, uint32_t coordType);

  /**
   * @copydoc Dali::Accessibility::Component::GetExtents()
   */
  DBus::ValueOrError<std::tuple<int32_t, int32_t, int32_t, int32_t> > GetExtents(uint32_t coordType);

  /**
   * @brief Gets the position from the given coordinate.
   * @param[in] coordType The enumeration with type of coordinate systems
   * @return The X and Y position of rectangle
   */
  DBus::ValueOrError<int32_t, int32_t> GetPosition(uint32_t coordType);

  /**
   * @brief Gets the size from the given coordinate.
   * @param[in] coordType The enumeration with type of coordinate systems
   * @return The width and height of rectangle
   */
  DBus::ValueOrError<int32_t, int32_t> GetSize(uint32_t coordType);

  /**
   * @copydoc Dali::Accessibility::Component::GetLayer()
   */
  DBus::ValueOrError<Dali::Accessibility::ComponentLayer> GetLayer();

  /**
   * @copydoc Dali::Accessibility::Component::GetAlpha()
   */
  DBus::ValueOrError<double> GetAlpha();

  /**
   * @copydoc Dali::Accessibility::Component::GrabFocus()
   */
  DBus::ValueOrError<bool> GrabFocus();

  /**
   * @copydoc Dali::Accessibility::Component::GrabHighlight()
   */
  DBus::ValueOrError<bool> GrabHighlight();

  /**
   * @copydoc Dali::Accessibility::Component::ClearHighlight()
   */
  DBus::ValueOrError<bool> ClearHighlight();

  /**
   * @copydoc Dali::Accessibility::Component::GetMdiZOrder()
   */
  DBus::ValueOrError<int16_t> GetMdiZOrder();
};

#endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_COMPONENT_H