Branch data     Line data    Source code

       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 _VCL_CONTROLLAYOUT_HXX
      21                 :            : #define _VCL_CONTROLLAYOUT_HXX
      22                 :            : 
      23                 :            : #include <vector>
      24                 :            : #include <tools/gen.hxx>
      25                 :            : #include <tools/string.hxx>
      26                 :            : #include <vcl/dllapi.h>
      27                 :            : 
      28                 :            : class Control;
      29                 :            : 
      30                 :            : namespace vcl
      31                 :            : {
      32                 :            : 
      33                 :            : struct VCL_DLLPUBLIC ControlLayoutData
      34                 :            : {
      35                 :            :     // contains the string really displayed
      36                 :            :     // there must be exactly one bounding rectangle in m_aUnicodeBoundRects
      37                 :            :     // for every character in m_aDisplayText
      38                 :            :     String                              m_aDisplayText;
      39                 :            :     // the bounding rectangle of every character
      40                 :            :     // where one character may consist of many glyphs
      41                 :            :     std::vector< Rectangle >            m_aUnicodeBoundRects;
      42                 :            :     // start indices of lines
      43                 :            :     std::vector< long >                 m_aLineIndices;
      44                 :            :     // notify parent control on destruction
      45                 :            :     const Control*                      m_pParent;
      46                 :            : 
      47 [ +  - ][ +  - ]:        208 :     ControlLayoutData() : m_pParent( NULL ) {}
      48                 :            :     ~ControlLayoutData();
      49                 :            : 
      50                 :            :     Rectangle GetCharacterBounds( long nIndex ) const;
      51                 :            :     // returns the character index for corresponding to rPoint (in control coordinates)
      52                 :            :     // -1 is returned if no character is at that point
      53                 :            :     long GetIndexForPoint( const Point& rPoint ) const;
      54                 :            :     // returns the number of lines in the result of GetDisplayText()
      55                 :            :     long GetLineCount() const;
      56                 :            :     // returns the interval [start,end] of line nLine
      57                 :            :     // returns [-1,-1] for an invalid line
      58                 :            :     Pair GetLineStartEnd( long nLine ) const;
      59                 :            :     /** ToRelativeLineIndex changes a layout data index to a count relative to its line.
      60                 :            : 
      61                 :            :     <p>This is equivalent to getting the line start/end pairs with
      62                 :            :     <member>GetLineStartEnd</member> until the index lies within [start,end] of a line
      63                 :            :     </p>
      64                 :            : 
      65                 :            :     @param nIndex
      66                 :            :     the absolute index inside the display text to be changed to a relative index
      67                 :            : 
      68                 :            :     @returns
      69                 :            :     the relative index inside the displayed line or -1 if the absolute index does
      70                 :            :     not match any line
      71                 :            :     */
      72                 :            :     long ToRelativeLineIndex( long nIndex ) const;
      73                 :            : };
      74                 :            : 
      75                 :            : } // namespace vcl
      76                 :            : 
      77                 :            : #endif // _VCL_CONTROLLAYOUT_HXX
      78                 :            : 
      79                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */