xref: /aoo41x/main/offapi/com/sun/star/awt/XFixedHyperlink.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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