accessible/mac/GeckoTextMarker.h

   1 /* clang-format off */
   2 /* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   3 /* clang-format on */
   4 /* vim: set ts=2 et sw=2 tw=80: */
   5 /* This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   8
   9 #ifndef _GeckoTextMarker_H_
  10 #define _GeckoTextMarker_H_
  11
  12 #include <ApplicationServices/ApplicationServices.h>
  13 #include <Foundation/Foundation.h>
  14
  15 #include "HyperTextAccessibleWrap.h"
  16 #include "PlatformExtTypes.h"
  17 #include "SDKDeclarations.h"
  18
  19 namespace mozilla {
  20 namespace a11y {
  21
  22 class Accessible;
  23 class GeckoTextMarkerRange;
  24
  25 class GeckoTextMarker final {
  26  public:
  27   GeckoTextMarker(Accessible* aContainer, int32_t aOffset)
  28       : mContainer(aContainer), mOffset(aOffset) {}
  29
  30   GeckoTextMarker(const GeckoTextMarker& aPoint)
  31       : mContainer(aPoint.mContainer), mOffset(aPoint.mOffset) {}
  32
  33   GeckoTextMarker(Accessible* aDoc, AXTextMarkerRef aTextMarker);
  34
  35   GeckoTextMarker() : mContainer(nullptr), mOffset(0) {}
  36
  37   static GeckoTextMarker MarkerFromIndex(Accessible* aRoot, int32_t aIndex);
  38
  39   AXTextMarkerRef CreateAXTextMarker();
  40
  41   bool Next();
  42
  43   bool Previous();
  44
  45   // Return a range with the given type relative to this marker.
  46   GeckoTextMarkerRange Range(EWhichRange aRangeType);
  47
  48   Accessible* Leaf();
  49
  50   bool IsValid() const { return !!mContainer; };
  51
  52   bool operator<(const GeckoTextMarker& aPoint) const;
  53
  54   bool operator==(const GeckoTextMarker& aPoint) const {
  55     return mContainer == aPoint.mContainer && mOffset == aPoint.mOffset;
  56   }
  57
  58   Accessible* mContainer;
  59   int32_t mOffset;
  60
  61   HyperTextAccessibleWrap* ContainerAsHyperTextWrap() const {
  62     return (mContainer && mContainer->IsLocal())
  63                ? static_cast<HyperTextAccessibleWrap*>(
  64                      mContainer->AsLocal()->AsHyperText())
  65                : nullptr;
  66   }
  67
  68  private:
  69   bool IsEditableRoot();
  70 };
  71
  72 class GeckoTextMarkerRange final {
  73  public:
  74   GeckoTextMarkerRange(const GeckoTextMarker& aStart,
  75                        const GeckoTextMarker& aEnd)
  76       : mStart(aStart), mEnd(aEnd) {}
  77
  78   GeckoTextMarkerRange() {}
  79
  80   GeckoTextMarkerRange(Accessible* aDoc, AXTextMarkerRangeRef aTextMarkerRange);
  81
  82   explicit GeckoTextMarkerRange(Accessible* aAccessible);
  83
  84   AXTextMarkerRangeRef CreateAXTextMarkerRange();
  85
  86   bool IsValid() const { return !!mStart.mContainer && !!mEnd.mContainer; };
  87
  88   /**
  89    * Return text enclosed by the range.
  90    */
  91   NSString* Text() const;
  92
  93   /**
  94    * Return the attributed text enclosed by the range.
  95    */
  96   NSAttributedString* AttributedText() const;
  97
  98   /**
  99    * Return length of characters enclosed by the range.
 100    */
 101   int32_t Length() const;
 102
 103   /**
 104    * Return screen bounds of range.
 105    */
 106   NSValue* Bounds() const;
 107
 108   /**
 109    * Set the current range as the DOM selection.
 110    */
 111   MOZ_CAN_RUN_SCRIPT_BOUNDARY void Select() const;
 112
 113   /**
 114    * Crops the range if it overlaps the given accessible element boundaries.
 115    * Return true if successfully cropped. false if the range does not intersect
 116    * with the container.
 117    */
 118   bool Crop(Accessible* aContainer);
 119
 120   GeckoTextMarker mStart;
 121   GeckoTextMarker mEnd;
 122 };
 123
 124 }  // namespace a11y
 125 }  // namespace mozilla
 126
 127 #endif