binfilter/inc/bf_svx/unoedhlp.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: unoedhlp.hxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SVX_UNOEDHLP_HXX
  32 #define _SVX_UNOEDHLP_HXX
  33
  34 #include <memory>
  35 #include <tools/solar.h>
  36 #include <tools/gen.hxx>
  37
  38 namespace binfilter {
  39
  40 struct EENotify;
  41 class EditEngine;
  42
  43 /** Helper class for common functionality in edit sources
  44  */
  45 class SvxEditSourceHelper
  46 {
  47 public:
  48     /** Calculate attribute run for EditEngines
  49
  50         Please note that the range returned is half-open: [nStartIndex,nEndIndex)
  51
  52         @param nStartIndex
  53         Herein, the start index of the range of similar attributes is returned
  54
  55         @param nEndIndex
  56         Herein, the end index (exclusive) of the range of similar attributes is returned
  57
  58         @param rEE
  59         The EditEngine to query for attributes
  60
  61         @param nPara
  62         The paragraph the following index value is to be interpreted in
  63
  64         @param nIndex
  65         The character index from which the range of similar attributed characters is requested
  66
  67         @return sal_True, if the range has been successfully determined
  68      */
  69     static sal_Bool GetAttributeRun( USHORT& nStartIndex, USHORT& nEndIndex, const EditEngine& rEE, USHORT nPara, USHORT nIndex );
  70
  71     /** Convert point from edit engine to user coordinate space
  72
  73         As the edit engine internally keeps vertical text unrotated,
  74         all internal edit engine methods return their stuff unrotated,
  75         too. This method rotates and shifts given point appropriately,
  76         if vertical writing is on.
  77
  78         @param rPoint
  79         Point to transform
  80
  81         @param rEESize
  82         Paper size of the edit engine
  83
  84         @param  bIsVertical
  85         Whether output text is vertical or not
  86
  87         @return the possibly transformed point
  88      */
  89     static Point EEToUserSpace( const Point& rPoint, const Size& rEESize, bool bIsVertical );
  90
  91     /** Convert point from user to edit engine coordinate space
  92
  93         As the edit engine internally keeps vertical text unrotated,
  94         all internal edit engine methods return their stuff unrotated,
  95         too. This method rotates and shifts given point appropriately,
  96         if vertical writing is on.
  97
  98         @param rPoint
  99         Point to transform
 100
 101         @param rEESize
 102         Paper size of the edit engine
 103
 104         @param  bIsVertical
 105         Whether output text is vertical or not
 106
 107         @return the possibly transformed point
 108      */
 109     static Point UserSpaceToEE( const Point& rPoint, const Size& rEESize, bool bIsVertical );
 110
 111     /** Convert rect from edit engine to user coordinate space
 112
 113         As the edit engine internally keeps vertical text unrotated,
 114         all internal edit engine methods return their stuff unrotated,
 115         too. This method rotates and shifts given rect appropriately,
 116         if vertical writing is on.
 117
 118         @param rRect
 119         Rectangle to transform
 120
 121         @param rEESize
 122         Paper size of the edit engine
 123
 124         @param  bIsVertical
 125         Whether output text is vertical or not
 126
 127         @return the possibly transformed rect
 128      */
 129     static Rectangle EEToUserSpace( const Rectangle& rRect, const Size& rEESize, bool bIsVertical );
 130 };
 131
 132 }//end of namespace binfilter
 133 #endif
 134