sw/inc/cshtyp.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: cshtyp.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 #ifndef _CSHTYP_HXX
  31 #define _CSHTYP_HXX
  32
  33 #include <tools/solar.h>
  34 #include "swdllapi.h"
  35
  36 class SwPaM;
  37 class SwCntntFrm;
  38 class SwLayoutFrm;
  39
  40 // eine Struktur fuer den SwPaM. In dieser stehen die Methoden-Pointer
  41 // fuer das richtungsabhaengige Bewegen des Cursors.
  42 struct SwMoveFnCollection;
  43 typedef SwMoveFnCollection* SwMoveFn;
  44
  45
  46 // Type-Definition fuer die CrsrShell
  47 // Richtungsparameter fuer MovePage ( wird in SwCntntFrm initialisiert )
  48 typedef SwLayoutFrm * (*SwWhichPage)( const SwLayoutFrm * );
  49 typedef SwCntntFrm  * (*SwPosPage)( const SwLayoutFrm * );
  50 extern SwWhichPage fnPagePrev, fnPageCurr, fnPageNext;
  51 extern SwPosPage fnPageStart, fnPageEnd;
  52
  53 // Richtungsparameter fuer MovePara ( wird in SwPaM initialisiert )
  54 typedef SwMoveFnCollection* SwPosPara;
  55 typedef BOOL (*SwWhichPara)( SwPaM&, SwPosPara );
  56 extern SwWhichPara fnParaPrev, fnParaCurr, fnParaNext;
  57 extern SwPosPara fnParaStart, fnParaEnd;
  58
  59 // Richtungsparameter fuer MoveSection
  60 typedef SwMoveFnCollection* SwPosSection;
  61 typedef BOOL (*SwWhichSection)( SwPaM&, SwPosSection );
  62 extern SwWhichSection fnSectionPrev, fnSectionCurr, fnSectionNext;
  63 extern SwPosSection fnSectionStart, fnSectionEnd;
  64
  65 // Richtungsparameter fuer MoveTable
  66 typedef SwMoveFnCollection* SwPosTable;
  67 typedef BOOL (*SwWhichTable)( SwPaM&, SwPosTable, BOOL bInReadOnly );
  68 extern SwWhichTable fnTablePrev, fnTableCurr, fnTableNext;
  69 extern SwPosTable fnTableStart, fnTableEnd;
  70
  71 // Richtungsparameter fuer MoveColumn
  72 typedef SwLayoutFrm * (*SwWhichColumn)( const SwLayoutFrm * );
  73 typedef SwCntntFrm  * (*SwPosColumn)( const SwLayoutFrm * );
  74 extern SwWhichColumn fnColumnPrev, fnColumnCurr, fnColumnNext;
  75 extern SwPosColumn fnColumnStart, fnColumnEnd;
  76
  77 // Richtungsparameter fuer MoveRegion   (Bereiche!)
  78 typedef SwMoveFnCollection* SwPosRegion;
  79 typedef BOOL (*SwWhichRegion)( SwPaM&, SwPosRegion, BOOL bInReadOnly );
  80 extern SwWhichRegion fnRegionPrev, fnRegionCurr, fnRegionNext, fnRegionCurrAndSkip;
  81 extern SwPosRegion fnRegionStart, fnRegionEnd;
  82
  83
  84
  85 /*
  86  * folgende Kombinationen sind erlaubt:
  87  *  - suche einen im Body:                                      -> FND_IN_BODY
  88  *  - suche alle im Body:                                       -> FND_IN_BODYONLY | FND_IN_SELALL
  89  *  - suche in Selectionen: einen / alle    -> FND_IN_SEL  [ | FND_IN_SELALL ]
  90  *  - suche im nicht Body: einen / alle     -> FND_IN_OTHER [ | FND_IN_SELALL ]
  91  *  - suche ueberall alle:                                      -> FND_IN_SELALL
  92  */
  93 enum FindRanges
  94 {
  95     FND_IN_BODY     = 0x00,     // suche "eins" mur im Body-Text
  96     FND_IN_OTHER    = 0x02,     // suche "alles" in Footer/Header/Fly...
  97     FND_IN_SEL      = 0x04,     // suche in Selectionen
  98     FND_IN_BODYONLY     = 0x08,         // suche nur im Body - nur in Verbindung mit
  99                                 // FND_IN_SELALL !!!
 100     FND_IN_SELALL   = 0x01              // - alle ( nur im nicht Body und Selectionen)
 101 };
 102
 103
 104 enum SwDocPositions
 105 {
 106     DOCPOS_START,
 107     DOCPOS_CURR,
 108     DOCPOS_END,
 109     DOCPOS_OTHERSTART,
 110     DOCPOS_OTHEREND
 111 };
 112
 113 SW_DLLPUBLIC SwWhichPara GetfnParaCurr();
 114 SW_DLLPUBLIC SwPosPara GetfnParaStart();
 115 SW_DLLPUBLIC SwPosPara GetfnParaEnd();
 116
 117 SW_DLLPUBLIC SwWhichTable GetfnTablePrev();
 118 SW_DLLPUBLIC SwWhichTable GetfnTableCurr();
 119 SW_DLLPUBLIC SwPosTable GetfnTableStart();
 120 SW_DLLPUBLIC SwPosTable GetfnTableEnd();
 121
 122 #endif  // _CSHTYP_HXX