include/vcl/controllayout.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_CONTROLLAYOUT_HXX
  21 #define INCLUDED_VCL_CONTROLLAYOUT_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <tools/gen.hxx>
  25 #include <vector>
  26 #include <vcl/dllapi.h>
  27 #include <vcl/ctrl.hxx>
  28
  29 namespace vcl
  30 {
  31
  32 struct VCL_DLLPUBLIC ControlLayoutData
  33 {
  34     // contains the string really displayed
  35     // there must be exactly one bounding rectangle in m_aUnicodeBoundRects
  36     // for every character in m_aDisplayText
  37     OUString                            m_aDisplayText;
  38     // the bounding rectangle of every character
  39     // where one character may consist of many glyphs
  40     std::vector< tools::Rectangle >            m_aUnicodeBoundRects;
  41     // start indices of lines
  42     std::vector< long >                 m_aLineIndices;
  43     // notify parent control on destruction
  44     VclPtr<const Control>               m_pParent;
  45
  46     ControlLayoutData();
  47     ~ControlLayoutData();
  48
  49     tools::Rectangle GetCharacterBounds( long nIndex ) const;
  50     // returns the character index for corresponding to rPoint (in control coordinates)
  51     // -1 is returned if no character is at that point
  52     long GetIndexForPoint( const Point& rPoint ) const;
  53     // returns the number of lines in the result of GetDisplayText()
  54     long GetLineCount() const;
  55     // returns the interval [start,end] of line nLine
  56     // returns [-1,-1] for an invalid line
  57     ::Pair GetLineStartEnd( long nLine ) const;
  58     /** ToRelativeLineIndex changes a layout data index to a count relative to its line.
  59
  60     This is equivalent to getting the line start/end pairs with
  61     GetLineStartEnd until the index lies within [start,end] of a line
  62
  63     @param nIndex
  64     the absolute index inside the display text to be changed to a relative index
  65
  66     @returns
  67     the relative index inside the displayed line or -1 if the absolute index does
  68     not match any line
  69     */
  70     long ToRelativeLineIndex( long nIndex ) const;
  71 };
  72
  73 } // namespace vcl
  74
  75 #endif // INCLUDED_VCL_CONTROLLAYOUT_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */