summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/FolderListEntry.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/FolderListEntry.idl')
-rw-r--r--offapi/com/sun/star/ucb/FolderListEntry.idl81
1 files changed, 81 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl
new file mode 100644
index 000000000000..ce231f975a12
--- /dev/null
+++ b/offapi/com/sun/star/ucb/FolderListEntry.idl
@@ -0,0 +1,81 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: FolderListEntry.idl,v $
+ * $Revision: 1.8 $
+ *
+ * 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