xref: /trunk/main/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl (revision fc9fd3f14a55d77b35643a64034752a178b2a5b0)
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_ui_dialogs_TemplateDescription_idl__
29#define __com_sun_star_ui_dialogs_TemplateDescription_idl__
30
31
32module com { module sun { module star { module ui { module dialogs {
33
34//=============================================================================
35/** The implementation of a FilePicker service may support the usage of
36    different templates. The following constants define the currently
37    specified templates.
38
39    @see com::sun::star::ui::dialogs::FilePicker
40 */
41
42published constants TemplateDescription
43{
44    //---------------------------------------------------------------------
45    /** A FileOpen dialog without any additional controls.
46    */
47    const short FILEOPEN_SIMPLE                                = 0;
48
49    //---------------------------------------------------------------------
50    /** A FileSave dialog without any additional controls.
51    */
52    const short FILESAVE_SIMPLE                                = 1;
53
54    //---------------------------------------------------------------------
55    /** A FileSave dialog with additional controls.
56        <ul>
57            <li>A checkbox "Auto Extension"</li>
58            <li>A checkbox "Password"</li>
59        </ul>
60    */
61    const short FILESAVE_AUTOEXTENSION_PASSWORD                = 2;
62
63    //---------------------------------------------------------------------
64    /** A FileSave dialog with additional controls.
65        <ul>
66            <li>A checkbox "Auto Extension"</li>
67            <li>A checkbox "Password"</li>
68            <li>A checkbox "Filter Options"</li>
69        </ul>
70    */
71    const short FILESAVE_AUTOEXTENSION_PASSWORD_FILTEROPTIONS  = 3;
72
73    //---------------------------------------------------------------------
74    /** A FileSave dialog with additional controls.
75        <ul>
76            <li>A checkbox "Auto Extension"</li>
77            <li>A checkbox "Selection"</li>
78        </ul>
79    */
80    const short FILESAVE_AUTOEXTENSION_SELECTION               = 4;
81
82    //---------------------------------------------------------------------
83    /** A FileSave dialog with additional controls.
84        <ul>
85            <li>A checkbox "Auto Extension"</li>
86            <li>A listbox "Template" for selecting different templates</li>
87        </ul>
88    */
89    const short FILESAVE_AUTOEXTENSION_TEMPLATE                = 5;
90
91    //---------------------------------------------------------------------
92    /** A FileOpen dialog with additional controls.
93        <ul>
94            <li>A checkbox "Insert as link"
95            <li>A checkbox "Show Preview"
96            <li>A listbox  "Image Template" for inserting an image with different styles.</li>
97            <li>A window for displaying a file preview</li>
98        </ul>
99    */
100    const short FILEOPEN_LINK_PREVIEW_IMAGE_TEMPLATE           = 6;
101
102    //---------------------------------------------------------------------
103    /** A FileOpen dialog with additional controls.
104        <ul>
105            <li>A push button "Play"</li>
106        </ul>
107    */
108    const short FILEOPEN_PLAY                                  = 7;
109
110    //---------------------------------------------------------------------
111    /** A FileOpen dialog with additional controls.
112        <ul>
113            <li>A checkbox "Read only"</li>
114            <li>A listbox "Version" for selecting a document version</li>
115        <ul>
116    */
117    const short FILEOPEN_READONLY_VERSION                      = 8;
118
119    //---------------------------------------------------------------------
120    /** A FileOpen dialog with additional controls.
121        <ul>
122            <li>A checkbox "Insert as link"</li>
123            <li>A checkbox "Show Preview"</li>
124            <li>A window for displaying a file preview</li>
125        </ul>
126    */
127    const short FILEOPEN_LINK_PREVIEW                          = 9;
128
129    //---------------------------------------------------------------------
130    /** A FileSave dialog with additional controls.
131        <ul>
132            <li>A checkbox "Auto Extension"</li>
133        </ul>
134    */
135    const short FILESAVE_AUTOEXTENSION                         = 10;
136
137};
138
139//=============================================================================
140
141}; }; }; }; };
142
143#endif
144