summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XCommandInfo.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/XCommandInfo.idl')
-rw-r--r--offapi/com/sun/star/ucb/XCommandInfo.idl149
1 files changed, 149 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XCommandInfo.idl b/offapi/com/sun/star/ucb/XCommandInfo.idl
new file mode 100644
index 000000000000..1244c2f6ec9c
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XCommandInfo.idl
@@ -0,0 +1,149 @@
+/*************************************************************************
+ *
+ * $RCSfile: XCommandInfo.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_ucb_XCommandInfo_idl__
+#define __com_sun_star_ucb_XCommandInfo_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_CommandInfo_idl__
+#include <com/sun/star/ucb/CommandInfo.idl>
+#endif
+
+#ifndef __com_sun_star_ucb_UnsupportedCommandException_idl__
+#include <com/sun/star/ucb/UnsupportedCommandException.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** provides access to information about executable commands.
+
+ @version 1.0
+ @author Kai Sommerfeld
+ @see XCommandTask
+*/
+[ uik(E2281A13-33D6-11D1-AABE00A0-249D5590), ident( "XCommandInfo", 1.0 ) ]
+interface XCommandInfo: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** @returns
+ a sequence of all commands supported by the object.
+ */
+ [const] sequence<com::sun::star::ucb::CommandInfo> getCommands();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ the command with the specified name from the object.
+
+ @param Name
+ specifies the name of the command.
+
+ @throws UnsupportedCommandException
+ if the command name is unknown to the object.
+ */
+ [const] com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
+ raises( com::sun::star::ucb::UnsupportedCommandException );
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ the command with the specified handle from the object.
+
+ @param Handle
+ specifies the handle of the command.
+
+ @throws UnsupportedCommandException
+ if the command handle is unknown to the object.
+ */
+ [const] com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
+ raises( com::sun::star::ucb::UnsupportedCommandException );
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ <TRUE/> if a command with the specified name is supported;
+ otherwise <FALSE/> is returned.
+
+ @param Name
+ specifies the name of the command.
+ */
+ [const] boolean hasCommandByName( [in] string Name );
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ <TRUE/> if a command with the specified handle is supported;
+ otherwise <FALSE/> is returned.
+
+ @param Name
+ specifies the handle of the command.
+ */
+ [const] boolean hasCommandByHandle( [in] long Handle );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif