xref: /aoo41x/main/offapi/com/sun/star/mozilla/XProfileDiscover.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_mozilla_XProfileDiscover_idl__
#define __com_sun_star_mozilla_XProfileDiscover_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_mozilla_MozillaProductType_idl__
#include <com/sun/star/mozilla/MozillaProductType.idl>
#endif


 module com {  module sun {  module star {  module mozilla {



/** is the interface used to list and get information for Mozilla/Thunderbird profiles


	@see com::sun::star::mozilla::XProfileManager
	@see com::sun::star::mozilla::MozillaBootstrap
 */
published interface XProfileDiscover: com::sun::star::uno::XInterface
{

	/** attempts to get the profiles count.

		@param product
			is the product name to get profiles count.Currently support "Mozilla" and "Thunderbird".
		@returns
			the profiles count of selected product.

	 */
	long getProfileCount( [in]MozillaProductType product);

	/** attempts to get the profile list for the given product.

		@param product
			is the product name to get profile list.Currently support "Mozilla" and "Thunderbird".
		@param list
			is a list of all profile of the given product.
		@returns
			the profile count for the given product.

	 */
	long getProfileList( [in]MozillaProductType product,[out] sequence<string> list);

	/** attempts to get the default profile name for the given product.

		@param product
			is the product name to get default profile.Currently support "Mozilla" and "Thunderbird".
		@returns
			the default profile name for the given product.

	 */
	string getDefaultProfile( [in]MozillaProductType product);


	/** attempts to get the full path for the given profile.

		@param product
			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
		@param profileName
			the profile name to get full path.
		@returns
			the full path of the given profile.

	 */
	string getProfilePath( [in]MozillaProductType product,[in]string profileName);

	/** attempts to get whether profile is locked by other applications.

		@param product
			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
		@param profileName
			the profile name to check.
		@returns
			true is the given profile is locked.

	 */
	boolean isProfileLocked( [in]MozillaProductType product,[in]string profileName);

	/** return true if the given profile exists

		@param product
			is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
		@param profileName
			the profile name to check.
		@returns
			whether given profile exists

	 */
	boolean getProfileExists( [in]MozillaProductType product,[in]string profileName);


};

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

}; }; }; };

#endif