reportdesign/source/ui/inc/MarkedSection.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: MarkedSection.hxx,v $
  10  * $Revision: 1.4 $
  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 RPTUI_MARKEDSECTION_HXX
  32 #define RPTUI_MARKEDSECTION_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35
  36 namespace rptui
  37 {
  38     class OSectionWindow; // forward declaration
  39
  40     enum NearSectionAccess
  41     {
  42         CURRENT = 0,
  43         PREVIOUS = -1,
  44         POST = 1
  45     };
  46
  47     class IMarkedSection
  48     {
  49     public:
  50         /** returns the section which is currently marked.
  51                 */
  52         virtual ::boost::shared_ptr<OSectionWindow> getMarkedSection(NearSectionAccess nsa) const =0;
  53
  54         /** mark the section on the given position .
  55         *
  56         * \param _nPos the position is zero based.
  57         */
  58         virtual void markSection(const sal_uInt16 _nPos) = 0;
  59     };
  60
  61 } // rptui
  62
  63 #endif /* RPTUI_MARKEDSECTION_HXX */