binfilter/inc/bf_svx/unoedsrc.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: unoedsrc.hxx,v $
  10  * $Revision: 1.10 $
  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_UNOEDSRC_HXX
  32 #define _SVX_UNOEDSRC_HXX
  33
  34 #ifndef _SOLAR_H
  35 #include <tools/solar.h>
  36 #endif
  37 #ifndef INCLUDED_I18NPOOL_LANG_H
  38 #include <i18npool/lang.h>
  39 #endif
  40 #ifndef _SV_MAPMOD_HXX
  41 #include <vcl/mapmod.hxx>
  42 #endif
  43
  44 #ifndef _SFXITEMPOOL_HXX //autogen
  45 #include <bf_svtools/itempool.hxx>
  46 #endif
  47 class OutputDevice;
  48 class String;
  49 namespace binfilter {
  50
  51 class SvUShorts;
  52 class SfxItemSet;
  53 class SfxBroadcaster;
  54
  55 struct ESelection;
  56 struct EFieldInfo;
  57 struct EBulletInfo;
  58 class SvxTextForwarder;
  59 class SvxViewForwarder;
  60 class SvxEditViewForwarder;
  61 class SvxFieldItem;
  62 class EECharAttribArray;
  63
  64 /**     Wrapper class for unified EditEngine/Outliner access
  65
  66     This class wraps a textual object, which might or might not
  67     contain an EditEngine/Outliner. Is used e.g. for filling an
  68     EditEngine with the content of a cell, note page or page template.
  69 */
  70 class SvxEditSource
  71 {
  72 public:
  73     virtual                                     ~SvxEditSource();
  74
  75     /// Returns a new reference to the same object. This is a shallow copy
  76     virtual SvxEditSource*              Clone() const = 0;
  77
  78     /** Query the text forwarder
  79
  80         @return the text forwarder, or NULL if the underlying object is dead
  81      */
  82     virtual SvxTextForwarder*   GetTextForwarder() = 0;
  83
  84     /** Query the view forwarder
  85
  86         @return the view forwarder, or NULL if the underlying object
  87         is dead, or if no view is available
  88
  89         @derive default implementation provided, overriding is optional
  90      */
  91      virtual SvxViewForwarder*  GetViewForwarder();
  92
  93     /** Query the edit view forwarder
  94
  95         @param bCreate
  96         Determines whether an EditView should be created, if there is
  97         none active. If set to sal_True, and the underlying object is
  98         not in EditMode, the text forwarder changes and the object is
  99         set to EditMode.
 100
 101         @return the edit view forwarder, or NULL if the underlying
 102         object is dead, or if no view is available (if bCreate is
 103         sal_False, NULL is also returned if the object is not in
 104         EditMode)
 105
 106         @derive default implementation provided, overriding is optional
 107
 108         @attention If this method is called with bCreate equal to
 109         sal_True, all previously returned text forwarder can become
 110         invalid
 111      */
 112      virtual SvxEditViewForwarder*      GetEditViewForwarder( sal_Bool bCreate = sal_False );
 113
 114     /// Write back data to model
 115     virtual void                                UpdateData() = 0;
 116
 117     /** Returns broadcaster the underlying edit engine's events are sent from
 118
 119         @derive default implementation provided, overriding is optional
 120      */
 121     virtual SfxBroadcaster&             GetBroadcaster() const;
 122
 123 };
 124
 125 /**     Contains an EditEngine or an Outliner and unifies access to them.
 126
 127     The EditEngine-UNO objects use this class only. To reflect changes
 128     not only in the EditEngine, but also in the model data, call
 129     SvxEditSource::UpdateData(). This copies back the data to the model's
 130     EditTextObject/OutlinerParaObject.
 131  */
 132 class SvxTextForwarder
 133 {
 134 public:
 135     virtual                             ~SvxTextForwarder();
 136
 137     virtual USHORT              GetParagraphCount() const = 0;
 138     virtual USHORT              GetTextLen( USHORT nParagraph ) const = 0;
 139     virtual String              GetText( const ESelection& rSel ) const = 0;
 140     virtual SfxItemSet  GetAttribs( const ESelection& rSel, BOOL bOnlyHardAttrib = 0 ) const = 0;
 141     virtual     SfxItemSet  GetParaAttribs( USHORT nPara ) const = 0;
 142     virtual void                SetParaAttribs( USHORT nPara, const SfxItemSet& rSet ) = 0;
 143     virtual void                GetPortions( USHORT nPara, SvUShorts& rList ) const = 0;
 144
 145     virtual USHORT              GetItemState( const ESelection& rSel, USHORT nWhich ) const = 0;
 146     virtual USHORT              GetItemState( USHORT nPara, USHORT nWhich ) const = 0;
 147
 148     virtual void                QuickInsertText( const String& rText, const ESelection& rSel ) = 0;
 149     virtual void                QuickInsertField( const SvxFieldItem& rFld, const ESelection& rSel ) = 0;
 150     virtual void                QuickSetAttribs( const SfxItemSet& rSet, const ESelection& rSel ) = 0;
 151     virtual void                QuickInsertLineBreak( const ESelection& rSel ) = 0;
 152
 153     virtual XubString    CalcFieldValue( const SvxFieldItem& rField, USHORT nPara, USHORT nPos, Color*& rpTxtColor, Color*& rpFldColor ) = 0;
 154
 155     virtual SfxItemPool* GetPool() const = 0;
 156
 157     /** Query state of forwarder
 158
 159         @return sal_False, if no longer valid
 160      */
 161     virtual BOOL                        IsValid() const = 0;
 162
 163     /** Query language of character at given position on the underlying edit engine
 164
 165         @param nPara[0 .. n-1]
 166         Index of paragraph to query language in
 167
 168         @param nIndex[0 .. m-1]
 169         Index of character to query language of
 170      */
 171     virtual LanguageType        GetLanguage( USHORT nPara, USHORT nIndex ) const = 0;
 172
 173     /** Query number of fields in the underlying edit engine
 174
 175         @param nPara[0 .. n-1]
 176         Index of paragraph to query field number in
 177      */
 178     virtual USHORT                      GetFieldCount( USHORT nPara ) const = 0;
 179
 180     /** Query information for given field number in the underlying edit engine
 181
 182         @param nPara[0 .. n-1]
 183         Index of paragraph to query field info in
 184
 185         @param nField[0 .. m-1]
 186         Index of field to query information of
 187      */
 188     virtual EFieldInfo          GetFieldInfo( USHORT nPara, USHORT nField ) const = 0;
 189
 190     /** Query information regarding bullets for given paragraph on the underlying edit engine
 191
 192         @param nPara[0 .. n-1]
 193         Index of paragraph to query bullet info on
 194      */
 195     virtual EBulletInfo     GetBulletInfo( USHORT nPara ) const = 0;
 196
 197     /** Query the bounding rectangle of the given character
 198
 199         @param nPara[0 .. n]
 200         Index of paragraph to query the bounds in.  <p>The virtual
 201         character after the last character of the represented text,
 202         i.e. the one at position n is a special case.  Because it does
 203         not represent an existing character its bounding box is
 204         defined in relation to preceding characters.  It should be
 205         rougly equivalent to the bounding box of some character when
 206         inserted at the end of the text.  Its height typically being
 207         the maximal height of all the characters in the text or the
 208         height of the preceding character, its width being at least
 209         one pixel so that the bounding box is not degenerate.<br>
 210
 211         @param nIndex[0 .. m-1]
 212         Index of character to query the bounds of
 213
 214         @return rectangle in logical coordinates, relative to upper
 215         left corner of text. The coordinates returned here are to be
 216         interpreted in the map mode given by GetMapMode().
 217     */
 218     virtual Rectangle           GetCharBounds( USHORT nPara, USHORT nIndex ) const = 0;
 219
 220     /** Query the bounding rectangle of the given paragraph
 221
 222         @param nPara[0 .. n-1]
 223         Index of paragraph to query the bounds of
 224
 225         @return rectangle in logical coordinates, relative to upper
 226         left corner of text. The coordinates returned here are to be
 227         interpreted in the map mode given by GetMapMode().
 228      */
 229     virtual Rectangle           GetParaBounds( USHORT nPara ) const = 0;
 230
 231     /** Query the map mode of the underlying EditEngine/Outliner
 232
 233         @return the map mode used on the EditEngine/Outliner. The
 234         values returned by GetParaBounds() and GetCharBounds() are to
 235         be interpreted in this map mode, the point given to
 236         GetIndexAtPoint() is interpreted in this map mode.
 237      */
 238     virtual MapMode                     GetMapMode() const = 0;
 239
 240     /** Query the reference output device of the underlying EditEngine/Outliner
 241
 242         @return the OutputDevice used from the EditEngine/Outliner to
 243         format the text. It should be used when performing e.g. font
 244         calculations, since this is usually a printer with fonts and
 245         resolution different from the screen.
 246      */
 247     virtual OutputDevice*       GetRefDevice() const = 0;
 248
 249     /** Query paragraph and character index of the character at the
 250         given point. Returns sal_True on success, sal_False otherwise
 251
 252         @param rPoint
 253         Point to query text position of. Is interpreted in logical
 254         coordinates, relativ to the upper left corner of the text, and
 255         in the map mode given by GetMapMode()
 256
 257         @param rPara[0 .. n-1]
 258         Index of paragraph the point is within
 259
 260         @param rIndex[0 .. m-1]
 261         Index of character the point is over
 262
 263         @return sal_True, if the point is over any text and both rPara and rIndex are valid
 264
 265      */
 266     virtual sal_Bool            GetIndexAtPoint( const Point& rPoint, USHORT& rPara, USHORT& rIndex ) const = 0;
 267
 268     /** Get the start and the end index of the word at the given index
 269
 270         An index value on a word leads from the first character of
 271         that word up to and including the last space before the next
 272         word. The index values returned do not contain any leading or
 273         trailing white-space. If the input indices are invalid,
 274         sal_False is returned.
 275
 276         @param nPara[0 .. n-1]
 277         Index of paragraph to start the search in
 278
 279         @param nIndex[0 .. m-1]
 280         Index of character to query the search on
 281
 282         @param rStart
 283         Start index (in the same paragraph)
 284
 285         @param rEnd
 286         End index (in the same paragraph), this point to the last
 287         character still contained in the query
 288
 289         @return sal_True, if the result is non-empty
 290      */
 291     virtual sal_Bool            GetWordIndices( USHORT nPara, USHORT nIndex, USHORT& rStart, USHORT& rEnd ) const = 0;
 292
 293     /** Query range of similar attributes
 294
 295         Please note that the range returned is half-open: [nStartIndex,nEndIndex)
 296
 297         @param nStartIndex
 298         Herein, the start index of the range of similar attributes is returned
 299
 300         @param nEndIndex
 301         Herein, the end index (exclusive) of the range of similar attributes is returned
 302
 303         @param nIndex
 304         The character index from which the range of similar attributed characters is requested
 305
 306         @return sal_True, if the range has been successfully determined
 307      */
 308     virtual sal_Bool            GetAttributeRun( USHORT& nStartIndex, USHORT& nEndIndex, USHORT nPara, USHORT nIndex ) const = 0;
 309
 310     /** Query number of lines in the formatted paragraph
 311
 312         @param nPara[0 .. n-1]
 313         Index of paragraph to query number of lines in
 314
 315         @return number of lines in given paragraph
 316
 317      */
 318     virtual USHORT                      GetLineCount( USHORT nPara ) const = 0;
 319
 320     /** Query line length
 321
 322         @param nPara[0 .. n-1]
 323         Index of paragraph to query line length in
 324
 325         @param nLine[0 .. m-1]
 326         Index of line in paragraph to query line length of
 327
 328      */
 329     virtual USHORT                      GetLineLen( USHORT nPara, USHORT nLine ) const = 0;
 330
 331     /** Delete given text range and reformat text
 332
 333         @param rSelection
 334         The text range to be deleted
 335
 336         @return sal_True if text has been successfully deleted
 337      */
 338     virtual sal_Bool            Delete( const ESelection& rSelection ) = 0;
 339
 340      /** Insert/Replace given text in given range and reformat text
 341
 342           @param rText
 343          Text to insert/replace
 344
 345          @param rSel
 346          Selection where text should be replaced. The empty selection inserts
 347
 348          @return sal_True if text has been successfully inserted
 349       */
 350     virtual sal_Bool            InsertText( const String& rText, const ESelection& rSel ) = 0;
 351
 352      /** Updates the formatting
 353
 354           @see EditEngine::QuickFormatDoc() for details
 355
 356          @return sal_True if text have been successfully reformatted
 357       */
 358     virtual sal_Bool            QuickFormatDoc( BOOL bFull=FALSE ) = 0;
 359
 360     /** Get the outline depth of given paragraph
 361
 362         @param nPara
 363         Index of the paragraph to query the depth of
 364
 365         @return the outline level of the given paragraph. The range is
 366         [0,n), where n is the maximal outline level.
 367      */
 368     virtual USHORT                      GetDepth( USHORT nPara ) const = 0;
 369
 370     /** Set the outline depth of given paragraph
 371
 372         @param nPara
 373         Index of the paragraph to set the depth of
 374
 375         @param nNewDepth
 376         The depth to set on the given paragraph. The range is
 377         [0,n), where n is the maximal outline level.
 378
 379         @return TRUE, if depth could be successfully set. Reasons for
 380         failure are e.g. the text does not support outline level
 381         (EditEngine), or the depth range is exceeded.
 382      */
 383     virtual sal_Bool            SetDepth( USHORT nPara, USHORT nNewDepth ) = 0;
 384
 385 };
 386
 387 /** Encapsulates the document view for the purpose of unified
 388     EditEngine/Outliner access.
 389
 390     This one has to be different from the SvxEditViewForwarder, since
 391     the latter is only valid in edit mode.
 392  */
 393 class SvxViewForwarder
 394 {
 395 public:
 396     virtual                             ~SvxViewForwarder();
 397
 398     /** Query state of forwarder
 399
 400         @return sal_False, if no longer valid
 401      */
 402     virtual BOOL                IsValid() const = 0;
 403
 404     /** Query visible area of the view containing the text
 405
 406         @return the visible rectangle of the text, i.e. the part of
 407         the EditEngine or Outliner that is currently on screen. The
 408         values are already in screen coordinates (pixel), and have to
 409         be relative to the EditEngine/Outliner's upper left corner.
 410      */
 411     virtual Rectangle   GetVisArea() const = 0;
 412
 413     /** Convert from logical, EditEngine-relative coordinates to screen coordinates
 414
 415         @param rPoint
 416         Point in logical, EditEngine-relative coordinates.
 417
 418         @param rMapMode
 419         The map mode to interpret the coordinates in.
 420
 421         @return the point in screen coordinates
 422      */
 423     virtual Point               LogicToPixel( const Point& rPoint, const MapMode& rMapMode ) const = 0;
 424
 425     /** Convert from screen to logical, EditEngine-relative coordinates
 426
 427         @param rPoint
 428         Point in screen coordinates
 429
 430         @param rMapMode
 431         The map mode to interpret the coordinates in.
 432
 433         @return the point in logical coordinates.
 434      */
 435     virtual Point               PixelToLogic( const Point& rPoint, const MapMode& rMapMode ) const = 0;
 436
 437 };
 438
 439 /** Encapsulates EditView and OutlinerView for the purpose of unified
 440     EditEngine/Outliner access
 441  */
 442 class SvxEditViewForwarder : public SvxViewForwarder
 443 {
 444 public:
 445
 446     /** Query current selection.
 447
 448         @param rSelection
 449         Contains the current selection after method call
 450
 451         @return sal_False, if there is no view or no selection (the empty selection _is_ a selection)
 452
 453      */
 454     virtual sal_Bool GetSelection( ESelection& rSelection ) const = 0;
 455
 456     /** Set selection in view.
 457
 458         @param rSelection
 459         The selection to set
 460
 461         @return sal_False, if there is no view or selection is invalid
 462      */
 463     virtual sal_Bool SetSelection( const ESelection& rSelection ) = 0;
 464
 465     /** Copy current selection to clipboard.
 466
 467         @return sal_False if no selection or no view (the empty selection _is_ a selection)
 468      */
 469     virtual sal_Bool Copy() = 0;
 470
 471     /** Cut current selection to clipboard.
 472
 473         @eturn sal_False if no selection or no view (the empty selection _is_ a selection)
 474      */
 475     virtual sal_Bool Cut() = 0;
 476
 477     /** Paste clipboard into current selection.
 478
 479         @return sal_False if no view or no selection (the empty selection _is_ a selection)
 480      */
 481     virtual sal_Bool Paste() = 0;
 482
 483 };
 484
 485 }//end of namespace binfilter
 486 #endif
 487