AOO410/main/offapi/com/sun/star/ucb/FolderListEntry.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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