sw/inc/cshtyp.hxx

   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 #ifndef _CSHTYP_HXX
  20 #define _CSHTYP_HXX
  21
  22 #include <tools/solar.h>
  23 #include "swdllapi.h"
  24
  25 class SwPaM;
  26 class SwCntntFrm;
  27 class SwLayoutFrm;
  28
  29 // Structure for SwPaM. Contains the method-pointers for cursor movement.
  30 struct SwMoveFnCollection;
  31 typedef SwMoveFnCollection* SwMoveFn;
  32
  33
  34 // Type definition for CrsrShell.
  35 // Direction-parameter for MovePage (initialized in SwCntntFrm).
  36 typedef SwLayoutFrm * (*SwWhichPage)( const SwLayoutFrm * );
  37 typedef SwCntntFrm  * (*SwPosPage)( const SwLayoutFrm * );
  38 extern SwWhichPage fnPagePrev, fnPageCurr, fnPageNext;
  39 extern SwPosPage fnPageStart, fnPageEnd;
  40
  41 // Direction-parameter for MovePara (initialized in SwCntntFrm).
  42 typedef SwMoveFnCollection* SwPosPara;
  43 typedef sal_Bool (*SwWhichPara)( SwPaM&, SwPosPara );
  44 extern SwWhichPara fnParaPrev, fnParaCurr, fnParaNext;
  45 extern SwPosPara fnParaStart, fnParaEnd;
  46
  47 // Direction-parameter for MoveSection.
  48 typedef SwMoveFnCollection* SwPosSection;
  49 typedef sal_Bool (*SwWhichSection)( SwPaM&, SwPosSection );
  50 extern SwWhichSection fnSectionPrev, fnSectionCurr, fnSectionNext;
  51 extern SwPosSection fnSectionStart, fnSectionEnd;
  52
  53 // Direction-parameter for MoveTable
  54 typedef SwMoveFnCollection* SwPosTable;
  55 typedef sal_Bool (*SwWhichTable)( SwPaM&, SwPosTable, sal_Bool bInReadOnly );
  56 extern SwWhichTable fnTablePrev, fnTableCurr, fnTableNext;
  57 extern SwPosTable fnTableStart, fnTableEnd;
  58
  59 // Direction-parameter for MoveColumn
  60 typedef SwLayoutFrm * (*SwWhichColumn)( const SwLayoutFrm * );
  61 typedef SwCntntFrm  * (*SwPosColumn)( const SwLayoutFrm * );
  62 extern SwWhichColumn fnColumnPrev, fnColumnCurr, fnColumnNext;
  63 extern SwPosColumn fnColumnStart, fnColumnEnd;
  64
  65 // Direction-parameter for MoveRegion (ranges!)
  66 typedef SwMoveFnCollection* SwPosRegion;
  67 typedef sal_Bool (*SwWhichRegion)( SwPaM&, SwPosRegion, sal_Bool bInReadOnly );
  68 extern SwWhichRegion fnRegionPrev, fnRegionCurr, fnRegionNext, fnRegionCurrAndSkip;
  69 extern SwPosRegion fnRegionStart, fnRegionEnd;
  70
  71
  72 /*
  73  * The following combinations are allowed:
  74  *  - find one in body                      -> FND_IN_BODY
  75  *  - find all in body:                     -> FND_IN_BODYONLY | FND_IN_SELALL
  76  *  - find in selections: one/all           -> FND_IN_SEL  [ | FND_IN_SELALL ]
  77  *  - find not in body: one/all             -> FND_IN_OTHER [ | FND_IN_SELALL ]
  78  *  - find all everywhere                   -> FND_IN_SELALL
  79  */
  80 enum FindRanges
  81 {
  82     FND_IN_BODY     = 0x00,     ///< Find "one" only in body text.
  83     FND_IN_OTHER    = 0x02,     ///< Find "all" in Footer/Header/Fly...
  84     FND_IN_SEL      = 0x04,     ///< Find in selections.
  85     FND_IN_BODYONLY = 0x08,     ///< Find only in body - only in combination with FND_IN_SELALL !!!
  86     FND_IN_SELALL   = 0x01      ///< All (only in non-body and selections).
  87 };
  88
  89
  90 enum SwDocPositions
  91 {
  92     DOCPOS_START,
  93     DOCPOS_CURR,
  94     DOCPOS_END,
  95     DOCPOS_OTHERSTART,
  96     DOCPOS_OTHEREND
  97 };
  98
  99 SW_DLLPUBLIC SwWhichPara GetfnParaCurr();
 100 SW_DLLPUBLIC SwPosPara GetfnParaStart();
 101 SW_DLLPUBLIC SwPosPara GetfnParaEnd();
 102
 103 SW_DLLPUBLIC SwWhichTable GetfnTablePrev();
 104 SW_DLLPUBLIC SwWhichTable GetfnTableCurr();
 105 SW_DLLPUBLIC SwPosTable GetfnTableStart();
 106 SW_DLLPUBLIC SwPosTable GetfnTableEnd();
 107
 108 #endif  // _CSHTYP_HXX
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */