summaryrefslogtreecommitdiff
path: root/dali/internal/accessibility/bridge/bridge-text.h
blob: 46a33e7ba1ed9686edfac05be589878ec58ec993 (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
#ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_H
#define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_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.
 *
 */

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

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

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

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

  /**
   * @copydoc Dali::Accessibility::Text::GetText()
   */
  DBus::ValueOrError<std::string> GetText(int startOffset, int endOffset);

  /**
   * @copydoc Dali::Accessibility::Text::GetCharacterCount()
   */
  DBus::ValueOrError<int32_t> GetCharacterCount();

  /**
   * @copydoc Dali::Accessibility::Text::GetCursorOffset()
   */
  DBus::ValueOrError<int32_t> GetCursorOffset();

  /**
   * @copydoc Dali::Accessibility::Text::SetCursorOffset()
   */
  DBus::ValueOrError<bool> SetCursorOffset(int32_t offset);

  /**
   * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
   */
  DBus::ValueOrError<std::string, int, int> GetTextAtOffset(int32_t offset, uint32_t boundary);

  /**
   * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
   */
  DBus::ValueOrError<int, int> GetRangeOfSelection(int32_t selectionIndex);

  /**
   * @copydoc Dali::Accessibility::Text::RemoveSelection()
   */
  DBus::ValueOrError<bool> RemoveSelection(int32_t selectionIndex);

  /**
   * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
   */
  DBus::ValueOrError<bool> SetRangeOfSelection(int32_t selectionIndex, int32_t startOffset, int32_t endOffset);

  /**
   * @copydoc Dali::Accessibility::Text::GetRangeExtents()
   */
  DBus::ValueOrError<int32_t, int32_t, int32_t, int32_t> GetRangeExtents(int32_t startOffset, int32_t endOffset, uint32_t coordType);
};

#endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_H