summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/FolderListEntry.idl
blob: 0652dd17c87e84ffba57876ee770a46d6d4b0262 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_FolderListEntry_idl__
#define __com_sun_star_ucb_FolderListEntry_idl__


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Information about a single folder in a <type>FolderList</type>.
*/
published struct FolderListEntry
{
    //-------------------------------------------------------------------------
    /** The title of the folder.
    */
    string Title;

    //-------------------------------------------------------------------------
    /** A (unique) identifier for the folder (used by IMAP, where different
        folders with equal human-readable titles may exist; otherwise, it may
        be left empty).
    */
    string ID;

    //-------------------------------------------------------------------------
    /** The foler is subscribed.
    */
    boolean Subscribed;

    //-------------------------------------------------------------------------
    /** The foler is new.
    */
    boolean New;

    //-------------------------------------------------------------------------
    /** The foler has been removed.
    */
    boolean Removed;

    //-------------------------------------------------------------------------
    /** The folder shall be purged (only used in conjunction with the
        <member>FolderListCommand::SET</member>).
    */
    boolean Purge;
};

//=============================================================================

}; }; }; };

#endif