offapi/com/sun/star/inspection/XHyperlinkControl.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: XHyperlinkControl.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_inspection_XHyperlinkControl_idl__
  32 #define __com_sun_star_inspection_XHyperlinkControl_idl__
  33
  34 #ifndef __com_sun_star_inspection_XPropertyControl_idl__
  35 #include <com/sun/star/inspection/XPropertyControl.idl>
  36 #endif
  37 #ifndef __com_sun_star_awt_XActionListener_idl__
  38 #include <com/sun/star/awt/XActionListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42 module com {  module sun {  module star {  module inspection {
  43
  44 //-----------------------------------------------------------------------------
  45 /** defines the interface for an <type>XPropertyControl</type> which displays its value
  46     in a hyperlink-like way
  47
  48     <p>Hyperlink controls exchange their value (<member>XPropertyControl::Value</member>) as strings.</p>
  49
  50     @since OOo 2.0.3
  51 */
  52 interface XHyperlinkControl : XPropertyControl
  53 {
  54     /** adds a listener which will be notified when the user clicked the hyperlink text in the control
  55         @param listener
  56             the listener to notify of hyperlink clicks
  57     */
  58     void addActionListener( [in] com::sun::star::awt::XActionListener listener );
  59
  60     /** removes a listener which was previously added via <member>addActionListener</member>
  61         @param listener
  62             the listener to revoke
  63     */
  64     void removeActionListener( [in] com::sun::star::awt::XActionListener listener );
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif
  72