offapi/com/sun/star/text/textfield/Database.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: Database.idl,v $
  10  * $Revision: 1.5 $
  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_text_textfield_Database_idl__
  32 #define __com_sun_star_text_textfield_Database_idl_
  33
  34 #include <com/sun/star/text/TextField.idl>
  35 #include <com/sun/star/text/DependentTextField.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module text { module textfield {
  40
  41 //=============================================================================
  42 /** specifies service of a database text field which is used as mail merge field.
  43     @see com::sun::star::text::TextField
  44 */
  45 published service Database
  46 {
  47     service  com::sun::star::text::DependentTextField;
  48
  49     /** contains the database content that was merged in the last database merge action.
  50      Initially it contains the colum name in parenthesis (<>).
  51      */
  52     [property]string Content;
  53     /** contains the current content of the text field.
  54         <p> This property is escpecially usefull for import/export purposes. </p>
  55      */
  56     [property]string CurrentPresentation;
  57     /** determins whether the number format is number display format is read
  58      from the database settings.
  59      */
  60     [property]boolean DataBaseFormat;
  61     /** this is the number format for this field.
  62         @see com::sun::star::util::NumberFormatter
  63     */
  64     [property]long NumberFormat;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; }; };
  70
  71 #endif
  72