offapi/com/sun/star/text/TemplateDisplayFormat.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: TemplateDisplayFormat.idl,v $
  10  * $Revision: 1.10 $
  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 #ifndef __com_sun_star_text_TemplateDisplayFormat_idl__
  31 #define __com_sun_star_text_TemplateDisplayFormat_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module text {
  37
  38 //=============================================================================
  39
  40 // DocMerge from idl: constants com::sun::star::text::TemplateDisplayFormat
  41 /** These constants are used to specify which information about a template is
  42         displayed in a field.
  43  */
  44 published constants TemplateDisplayFormat
  45 {
  46     //-------------------------------------------------------------------------
  47     // The complete path of the file will be displayed.
  48
  49     // DocMerge: empty anyway
  50     const short FULL = 0;
  51
  52     //-------------------------------------------------------------------------
  53     // Only the path of the template file will be displayed.
  54
  55     // DocMerge: empty anyway
  56     const short PATH = 1;
  57
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from idl: value com::sun::star::text::TemplateDisplayFormat::NAME
  61     /** Only the file name, without file extension, of the template
  62                 file will be displayed.
  63      */
  64     const short NAME = 2;
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from idl: value com::sun::star::text::TemplateDisplayFormat::NAME_AND_EXT
  69     /** The file name and the file extension of the template
  70                 file will be displayed.
  71      */
  72     const short NAME_AND_EXT = 3;
  73
  74     //-------------------------------------------------------------------------
  75
  76     // DocMerge from idl: value com::sun::star::text::TemplateDisplayFormat::AREA
  77     /** The name of the template area is displayed.
  78      */
  79     const short AREA = 4;
  80
  81     //-------------------------------------------------------------------------
  82
  83     // DocMerge from idl: value com::sun::star::text::TemplateDisplayFormat::TITLE
  84     /** The title of the template file is displayed.
  85      */
  86     const short TITLE = 5;
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif