ICU-62107.0.1.tar.gz

[apple/icu.git] / icuSources / layoutex / layout / ParagraphLayout.h

diff --git a/icuSources/layoutex/layout/ParagraphLayout.h b/icuSources/layoutex/layout/ParagraphLayout.h
index bce2e2d4ee3c2a2cf5b15b6875baf1b918945fe4..0d9f08f7343f0fcbfd66e3d81a3c070692419302 100644 (file)
--- a/icuSources/layoutex/layout/ParagraphLayout.h
+++ b/icuSources/layoutex/layout/ParagraphLayout.h
@@ -1,6 +1,8 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
  **********************************************************************
- *   Copyright (C) 2002-2005, International Business Machines
+ *   Copyright (C) 2002-2014, International Business Machines
  *   Corporation and others.  All Rights Reserved.
  **********************************************************************
  */
@@ -40,6 +42,13 @@ U_NAMESPACE_BEGIN
  *
  * Clients can use this to break a paragraph into lines, and to display the glyphs in each line.
  *
+ * Note that {@link icu::LayoutEngine} is deprecated, but this class is not.
+ * You may use this class with the HarfBuzz icu-le-hb wrapper,
+ *  see http://www.freedesktop.org/wiki/Software/HarfBuzz/
+ *
+ *  See http://userguide.icu-project.org/layoutengine for special build instructions.
+ *
+ * @see icu::LayoutEngine
  */
 class U_LAYOUTEX_API ParagraphLayout : public UObject
 {
@@ -499,6 +508,19 @@ public:
      */
     inline void reflow();
 
+#ifndef U_HIDE_INTERNAL_API
+    /**
+     *
+     * Convenience method for determining if paragraph layout processing is complete ( i.e. there
+     * are no more lines left to process. )
+     *
+     * @return true if there are no more lines to be processed
+     *
+     * @internal 
+     */
+    inline le_bool isDone() const;
+#endif  /* U_HIDE_INTERNAL_API */
+
     /**
      * Return a <code>ParagraphLayout::Line</code> object which represents next line
      * in the paragraph. The width of the line is specified each time so that it can