sw/source/core/access/textmarkuphelper.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: textmarkuphelper.hxx,v $
  10  * $Revision: 1.2 $
  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 _TEXTMARKUPHELPER_HXX_
  31 #define _TEXTMARKUPHELPER_HXX_
  32
  33 #include <sal/types.h>
  34 #include "com/sun/star/lang/IndexOutOfBoundsException.hdl"
  35 #include "com/sun/star/lang/IllegalArgumentException.hdl"
  36 #include "com/sun/star/uno/RuntimeException.hdl"
  37 #include "com/sun/star/uno/Sequence.h"
  38
  39 namespace com { namespace sun { namespace star { namespace accessibility {
  40 struct TextSegment;
  41 } } } }
  42
  43 class SwTxtNode;
  44 class SwAccessiblePortionData;
  45
  46 class SwTextMarkupHelper
  47 {
  48     public:
  49         SwTextMarkupHelper( const SwTxtNode& rTxtNode,
  50                             const SwAccessiblePortionData& rPortionData );
  51         ~SwTextMarkupHelper() {}
  52
  53         sal_Int32 getTextMarkupCount( sal_Int32 nTextMarkupType )
  54                 throw (::com::sun::star::lang::IllegalArgumentException,
  55                        ::com::sun::star::uno::RuntimeException);
  56
  57         ::com::sun::star::accessibility::TextSegment getTextMarkup(
  58                                                     sal_Int32 nTextMarkupIndex,
  59                                                     sal_Int32 nTextMarkupType )
  60                 throw (::com::sun::star::lang::IndexOutOfBoundsException,
  61                        ::com::sun::star::lang::IllegalArgumentException,
  62                        ::com::sun::star::uno::RuntimeException);
  63
  64         ::com::sun::star::uno::Sequence< ::com::sun::star::accessibility::TextSegment >
  65                 getTextMarkupAtIndex( sal_Int32 nCharIndex,
  66                                       sal_Int32 nTextMarkupType )
  67                 throw (::com::sun::star::lang::IndexOutOfBoundsException,
  68                        ::com::sun::star::lang::IllegalArgumentException,
  69                        ::com::sun::star::uno::RuntimeException);
  70
  71     private:
  72         SwTextMarkupHelper( const SwTextMarkupHelper& );
  73         SwTextMarkupHelper& operator=( const SwTextMarkupHelper& );
  74
  75         const SwTxtNode& mrTxtNode;
  76         const SwAccessiblePortionData& mrPortionData;
  77 };
  78 #endif
  79