offapi/com/sun/star/sheet/XHeaderFooterContent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
  29 #define __com_sun_star_sheet_XHeaderFooterContent_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_text_XText_idl__
  36 #include <com/sun/star/text/XText.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** provides access to the text contents of a header or footer on a page.
  46
  47     @see com::sun::star::sheet::HeaderFooterContent
  48     @see com::sun::star::sheet::TablePageStyle
  49  */
  50 published interface XHeaderFooterContent: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns the text which is printed in the left part of the
  55         header or footer.
  56
  57         @see com::sun::star::text::Text
  58      */
  59     com::sun::star::text::XText getLeftText();
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** returns the text which is printed in the center part of the
  64         header or footer.
  65
  66         @see com::sun::star::text::Text
  67      */
  68     com::sun::star::text::XText getCenterText();
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** returns the text which is printed in the right part of the
  73         header or footer.
  74
  75         @see com::sun::star::text::Text
  76      */
  77     com::sun::star::text::XText getRightText();
  78
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86