1 files changed, 85 insertions, 0 deletions
diff --git a/vcl/inc/vcl/controllayout.hxx b/vcl/inc/vcl/controllayout.hxx
new file mode 100644
index 000000000000..574d80ea9e02
--- /dev/null
+++ b/vcl/inc/vcl/controllayout.hxx
@@ -0,0 +1,85 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef _VCL_CONTROLLAYOUT_HXX
+#define _VCL_CONTROLLAYOUT_HXX
+
+#include <vector>
+#include <tools/gen.hxx>
+#include <tools/string.hxx>
+#include <vcl/dllapi.h>
+
+class Control;
+
+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
+    String                              m_aDisplayText;
+    // the bounding rectangle of every character
+    // where one character may consist of many glyphs
+    std::vector< Rectangle >            m_aUnicodeBoundRects;
+    // start indices of lines
+    std::vector< long >                 m_aLineIndices;
+    // notify parent control on destruction
+    const Control*                      m_pParent;
+
+    ControlLayoutData() : m_pParent( NULL ) {}
+    ~ControlLayoutData();
+
+    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.
+
+    <p>This is equivalent to getting the line start/end pairs with
+    <member>GetLineStartEnd</member> until the index lies within [start,end] of a line
+    </p>
+
+    @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 // _VCL_CONTROLLAYOUT_HXX