offapi/com/sun/star/awt/XFixedHyperlink.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: XFixedHyperlink.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef __com_sun_star_awt_XFixedHyperlink_idl__
  31 #define __com_sun_star_awt_XFixedHyperlink_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XActionListener_idl__
  38 #include <com/sun/star/awt/XActionListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module awt {
  44
  45 //=============================================================================
  46
  47 /** gives access to the text and formatting of a fixed hyperlink field.
  48  */
  49 interface XFixedHyperlink: com::sun::star::uno::XInterface
  50 {
  51         //-------------------------------------------------------------------------
  52
  53         /** sets the text of the control.
  54          */
  55         [oneway] void setText( [in] string Text );
  56
  57         //-------------------------------------------------------------------------
  58
  59         /** returns the text of the control.
  60          */
  61         string getText();
  62
  63         //-------------------------------------------------------------------------
  64
  65         /** sets the url of the control.
  66          */
  67         [oneway] void setURL( [in] string URL );
  68
  69         //-------------------------------------------------------------------------
  70
  71         /** returns the url of the control.
  72          */
  73         string getURL();
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** sets the alignment of the text in the control.
  78
  79         <pre>
  80         0: left
  81         1: center
  82         2: right
  83         </pre>
  84      */
  85     [oneway] void setAlignment( [in] short nAlign );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** returns the alignment of the text in the control.
  90      */
  91     short getAlignment();
  92
  93         //-------------------------------------------------------------------------
  94
  95         /** registers an event handler for click action event.
  96          */
  97         [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
  98
  99         //-------------------------------------------------------------------------
 100
 101         /** unregisters an event handler for click action event.
 102          */
 103         [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
 104
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif
 112