offapi/com/sun/star/awt/XFixedHyperlink.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XFixedHyperlink_idl__
  29 #define __com_sun_star_awt_XFixedHyperlink_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/awt/XActionListener.idl>
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module awt {
  37
  38 //=============================================================================
  39
  40 /** gives access to the text and formatting of a fixed hyperlink field.
  41  */
  42 interface XFixedHyperlink: com::sun::star::uno::XInterface
  43 {
  44         //-------------------------------------------------------------------------
  45
  46         /** sets the text of the control.
  47          */
  48         [oneway] void setText( [in] string Text );
  49
  50         //-------------------------------------------------------------------------
  51
  52         /** returns the text of the control.
  53          */
  54         string getText();
  55
  56         //-------------------------------------------------------------------------
  57
  58         /** sets the url of the control.
  59          */
  60         [oneway] void setURL( [in] string URL );
  61
  62         //-------------------------------------------------------------------------
  63
  64         /** returns the url of the control.
  65          */
  66         string getURL();
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** sets the alignment of the text in the control.
  71
  72         <pre>
  73         0: left
  74         1: center
  75         2: right
  76         </pre>
  77      */
  78     [oneway] void setAlignment( [in] short nAlign );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the alignment of the text in the control.
  83      */
  84     short getAlignment();
  85
  86         //-------------------------------------------------------------------------
  87
  88         /** registers an event handler for click action event.
  89          */
  90         [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
  91
  92         //-------------------------------------------------------------------------
  93
  94         /** unregisters an event handler for click action event.
  95          */
  96         [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */