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

   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: XHeaderFooterContent.idl,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
  31 #ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
  32 #define __com_sun_star_sheet_XHeaderFooterContent_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_text_XText_idl__
  39 #include <com/sun/star/text/XText.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access to the text contents of a header or footer on a page.
  49
  50     @see com::sun::star::sheet::HeaderFooterContent
  51     @see com::sun::star::sheet::TablePageStyle
  52  */
  53 published interface XHeaderFooterContent: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** returns the text which is printed in the left part of the
  58         header or footer.
  59
  60         @see com::sun::star::text::Text
  61      */
  62     com::sun::star::text::XText getLeftText();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** returns the text which is printed in the center part of the
  67         header or footer.
  68
  69         @see com::sun::star::text::Text
  70      */
  71     com::sun::star::text::XText getCenterText();
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** returns the text which is printed in the right part of the
  76         header or footer.
  77
  78         @see com::sun::star::text::Text
  79      */
  80     com::sun::star::text::XText getRightText();
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif
  89