office-gobmx/offapi/com/sun/star/sheet/XHeaderFooterContent.idl

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
#define __com_sun_star_sheet_XHeaderFooterContent_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_text_XText_idl__
#include <com/sun/star/text/XText.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides access to the text contents of a header or footer on a page.

    @see com::sun::star::sheet::HeaderFooterContent
    @see com::sun::star::sheet::TablePageStyle
 */
published interface XHeaderFooterContent: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the text which is printed in the left part of the
        header or footer.

        @see com::sun::star::text::Text
     */
    com::sun::star::text::XText getLeftText();

    //-------------------------------------------------------------------------

    /** returns the text which is printed in the center part of the
        header or footer.

        @see com::sun::star::text::Text
     */
    com::sun::star::text::XText getCenterText();

    //-------------------------------------------------------------------------

    /** returns the text which is printed in the right part of the
        header or footer.

        @see com::sun::star::text::Text
     */
    com::sun::star::text::XText getRightText();

};

//=============================================================================

}; }; }; };

#endif