diff options
Diffstat (limited to 'offapi/com/sun/star/form/DatabaseParameterEvent.idl')
-rw-r--r-- | offapi/com/sun/star/form/DatabaseParameterEvent.idl | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/DatabaseParameterEvent.idl b/offapi/com/sun/star/form/DatabaseParameterEvent.idl new file mode 100644 index 000000000000..f933f612e345 --- /dev/null +++ b/offapi/com/sun/star/form/DatabaseParameterEvent.idl @@ -0,0 +1,70 @@ +/************************************************************************* + * + * 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_form_DatabaseParameterEvent_idl__ +#define __com_sun_star_form_DatabaseParameterEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module form { + +//============================================================================= + +/** is fired if values for parameters are needed. + */ +published struct DatabaseParameterEvent: com::sun::star::lang::EventObject +{ + /** specifies the list of parameters which are required for opening a result set. + + <p>Usually, a <type scope="com::sun::star::form::component">DataForm</type> fires this + event when loading the form requires parameters to be filled in.</p> + + <p>Every parameter object supports the <type scope="com::sun::star::beans">XPropertySet</type> + interface, and at least the properties <em>Name</em> and <em>Value</em></p> + + @see com::sun::star::sdb::RowSet + @see com::sun::star::form::component::DataForm + */ + com::sun::star::container::XIndexAccess Parameters; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif |