xref: /aoo42x/main/offapi/com/sun/star/awt/XFixedHyperlink.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_awt_XFixedHyperlink_idl__
#define __com_sun_star_awt_XFixedHyperlink_idl__

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

#ifndef __com_sun_star_awt_XActionListener_idl__
#include <com/sun/star/awt/XActionListener.idl>
#endif

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

 module com {  module sun {  module star {  module awt {

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

/** gives access to the text and formatting of a fixed hyperlink field.
 */
published interface XFixedHyperlink: com::sun::star::uno::XInterface
{
        //-------------------------------------------------------------------------

        /** sets the text of the control.
         */
        [oneway] void setText( [in] string Text );

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

        /** returns the text of the control.
         */
        string getText();

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

        /** sets the url of the control.
         */
        [oneway] void setURL( [in] string URL );

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

        /** returns the url of the control.
         */
        string getURL();

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

    /** sets the alignment of the text in the control.

        <pre>
        0: left
        1: center
        2: right
        </pre>
     */
    [oneway] void setAlignment( [in] short nAlign );

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

    /** returns the alignment of the text in the control.
     */
    short getAlignment();

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

        /** registers an event handler for click action event.
         */
        [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );

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

        /** unregisters an event handler for click action event.
         */
        [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );

};

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

}; }; }; };

#endif