svx/inc/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.8 $
  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 <svtools/textdata.hxx>
  37 #include <svtools/hint.hxx>
  38 #include <tools/gen.hxx>
  39 #include "svx/svxdllapi.h"
  40
  41 struct EENotify;
  42 class EditEngine;
  43
  44 #define EDITSOURCE_HINT_PARASMOVED                      20
  45 #define EDITSOURCE_HINT_SELECTIONCHANGED        21
  46
  47 /** Extends TextHint by two additional parameters which are necessary
  48     for the EDITSOURCE_HINT_PARASMOVED hint. TextHint's value in this
  49     case denotes the destination position, the two parameters the
  50     start and the end of the moved paragraph range.
  51  */
  52 class SVX_DLLPUBLIC SvxEditSourceHint : public TextHint
  53 {
  54 private:
  55     ULONG       mnStart;
  56     ULONG       mnEnd;
  57
  58 public:
  59             TYPEINFO();
  60             SvxEditSourceHint( ULONG nId );
  61             SvxEditSourceHint( ULONG nId, ULONG nValue, ULONG nStart=0, ULONG nEnd=0 );
  62
  63     ULONG       GetValue() const;
  64     ULONG       GetStartValue() const;
  65     ULONG       GetEndValue() const;
  66     void        SetValue( ULONG n );
  67     void        SetStartValue( ULONG n );
  68     void        SetEndValue( ULONG n );
  69 };
  70
  71 /** Helper class for common functionality in edit sources
  72  */
  73 class SVX_DLLPUBLIC SvxEditSourceHelper
  74 {
  75 public:
  76
  77     /** Translates EditEngine notifications into broadcastable hints
  78
  79         @param aNotify
  80         Notification object send by the EditEngine.
  81
  82         @return the translated hint
  83      */
  84     static ::std::auto_ptr<SfxHint> EENotification2Hint( EENotify* aNotify );
  85
  86     /** Calculate attribute run for EditEngines
  87
  88         Please note that the range returned is half-open: [nStartIndex,nEndIndex)
  89
  90         @param nStartIndex
  91         Herein, the start index of the range of similar attributes is returned
  92
  93         @param nEndIndex
  94         Herein, the end index (exclusive) of the range of similar attributes is returned
  95
  96         @param rEE
  97         The EditEngine to query for attributes
  98
  99         @param nPara
 100         The paragraph the following index value is to be interpreted in
 101
 102         @param nIndex
 103         The character index from which the range of similar attributed characters is requested
 104
 105         @return sal_True, if the range has been successfully determined
 106      */
 107     static sal_Bool GetAttributeRun( USHORT& nStartIndex, USHORT& nEndIndex, const EditEngine& rEE, USHORT nPara, USHORT nIndex );
 108
 109     /** Convert point from edit engine to user coordinate space
 110
 111         As the edit engine internally keeps vertical text unrotated,
 112         all internal edit engine methods return their stuff unrotated,
 113         too. This method rotates and shifts given point appropriately,
 114         if vertical writing is on.
 115
 116         @param rPoint
 117         Point to transform
 118
 119         @param rEESize
 120         Paper size of the edit engine
 121
 122         @param  bIsVertical
 123         Whether output text is vertical or not
 124
 125         @return the possibly transformed point
 126      */
 127     static Point EEToUserSpace( const Point& rPoint, const Size& rEESize, bool bIsVertical );
 128
 129     /** Convert point from user to edit engine coordinate space
 130
 131         As the edit engine internally keeps vertical text unrotated,
 132         all internal edit engine methods return their stuff unrotated,
 133         too. This method rotates and shifts given point appropriately,
 134         if vertical writing is on.
 135
 136         @param rPoint
 137         Point to transform
 138
 139         @param rEESize
 140         Paper size of the edit engine
 141
 142         @param  bIsVertical
 143         Whether output text is vertical or not
 144
 145         @return the possibly transformed point
 146      */
 147     static Point UserSpaceToEE( const Point& rPoint, const Size& rEESize, bool bIsVertical );
 148
 149     /** Convert rect from edit engine to user coordinate space
 150
 151         As the edit engine internally keeps vertical text unrotated,
 152         all internal edit engine methods return their stuff unrotated,
 153         too. This method rotates and shifts given rect appropriately,
 154         if vertical writing is on.
 155
 156         @param rRect
 157         Rectangle to transform
 158
 159         @param rEESize
 160         Paper size of the edit engine
 161
 162         @param  bIsVertical
 163         Whether output text is vertical or not
 164
 165         @return the possibly transformed rect
 166      */
 167     static Rectangle EEToUserSpace( const Rectangle& rRect, const Size& rEESize, bool bIsVertical );
 168
 169     /** Convert rect from user to edit engine coordinate space
 170
 171         As the edit engine internally keeps vertical text unrotated,
 172         all internal edit engine methods return their stuff unrotated,
 173         too. This method rotates and shifts given rect appropriately,
 174         if vertical writing is on.
 175
 176         @param rRect
 177         Rectangle to transform
 178
 179         @param rEESize
 180         Paper size of the edit engine
 181
 182         @param  bIsVertical
 183         Whether output text is vertical or not
 184
 185         @return the possibly transformed rect
 186      */
 187     static Rectangle UserSpaceToEE( const Rectangle& rRect, const Size& rEESize, bool bIsVertical );
 188
 189 };
 190
 191 #endif
 192