1 files changed, 81 insertions, 0 deletions
diff --git a/include/vcl/toolkit/controllayout.hxx b/include/vcl/toolkit/controllayout.hxx
new file mode 100644
index 000000000..ffd643f64
--- /dev/null
+++ b/include/vcl/toolkit/controllayout.hxx
@@ -0,0 +1,81 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you 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 .
+ */
+
+#ifndef INCLUDED_VCL_CONTROLLAYOUT_HXX
+#define INCLUDED_VCL_CONTROLLAYOUT_HXX
+
+#if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
+#error "don't use this in new code"
+#endif
+
+#include <rtl/ustring.hxx>
+#include <tools/gen.hxx>
+#include <vector>
+#include <vcl/ctrl.hxx>
+#include <vcl/dllapi.h>
+
+namespace vcl
+{
+
+struct VCL_DLLPUBLIC ControlLayoutData
+{
+    // contains the string really displayed
+    // there must be exactly one bounding rectangle in m_aUnicodeBoundRects
+    // for every character in m_aDisplayText
+    OUString                            m_aDisplayText;
+    // the bounding rectangle of every character
+    // where one character may consist of many glyphs
+    std::vector< tools::Rectangle >            m_aUnicodeBoundRects;
+    // start indices of lines
+    std::vector< long >                 m_aLineIndices;
+    // notify parent control on destruction
+    VclPtr<const Control>               m_pParent;
+
+    ControlLayoutData();
+    ~ControlLayoutData();
+
+    tools::Rectangle GetCharacterBounds( long nIndex ) const;
+    // returns the character index for corresponding to rPoint (in control coordinates)
+    // -1 is returned if no character is at that point
+    long GetIndexForPoint( const Point& rPoint ) const;
+    // returns the number of lines in the result of GetDisplayText()
+    long GetLineCount() const;
+    // returns the interval [start,end] of line nLine
+    // returns [-1,-1] for an invalid line
+    ::Pair GetLineStartEnd( long nLine ) const;
+    /** ToRelativeLineIndex changes a layout data index to a count relative to its line.
+
+    This is equivalent to getting the line start/end pairs with
+    GetLineStartEnd until the index lies within [start,end] of a line
+
+    @param nIndex
+    the absolute index inside the display text to be changed to a relative index
+
+    @returns
+    the relative index inside the displayed line or -1 if the absolute index does
+    not match any line
+    */
+    long ToRelativeLineIndex( long nIndex ) const;
+};
+
+} // namespace vcl
+
+#endif // INCLUDED_VCL_CONTROLLAYOUT_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */