offapi/com/sun/star/text/textfield/URL.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_text_textfield_URL_idl__
  29 #define __com_sun_star_text_textfield_URL_idl_
  30
  31 #include <com/sun/star/text/TextField.idl>
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module text { module textfield {
  36
  37 //=============================================================================
  38 /** specifies service of text field that displays a URL
  39
  40     @see com::sun::star::text::TextField
  41 */
  42 published service URL
  43 {
  44     service  com::sun::star::text::TextField;
  45
  46     /** Speciefies how the URL is formated on output.
  47     */
  48     [property] short Format;
  49
  50     /** contains the unparsed original URL, for example,
  51         http://me:pass@www.sun.de:8080/pub/test/foo.txt?a=b#xyz
  52      */
  53     [property] string URL;
  54
  55     /** contains the content that will be displayed to the user.
  56         <p> If this string is empty, the <code>URL</code> will be shown.
  57      */
  58     [property] string Representation;
  59
  60     /** Specifies the frame name in that the URL will be opened
  61       */
  62     [property] string TargetFrame;
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; }; };
  68
  69 #endif
  70