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