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

   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
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides access to the text contents of a header or footer on a page.
  25
  26     @see com::sun::star::sheet::HeaderFooterContent
  27     @see com::sun::star::sheet::TablePageStyle
  28  */
  29 published interface XHeaderFooterContent: com::sun::star::uno::XInterface
  30 {
  31
  32     /** returns the text which is printed in the left part of the
  33         header or footer.
  34
  35         @see com::sun::star::text::Text
  36      */
  37     com::sun::star::text::XText getLeftText();
  38
  39
  40     /** returns the text which is printed in the center part of the
  41         header or footer.
  42
  43         @see com::sun::star::text::Text
  44      */
  45     com::sun::star::text::XText getCenterText();
  46
  47
  48     /** returns the text which is printed in the right part of the
  49         header or footer.
  50
  51         @see com::sun::star::text::Text
  52      */
  53     com::sun::star::text::XText getRightText();
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */