diff options
Diffstat (limited to 'offapi/drafts/com/sun/star/form')
| -rw-r--r-- | offapi/drafts/com/sun/star/form/IncompatibleTypesException.idl | 57 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/ListEntryEvent.idl | 77 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/XBindableValue.idl | 81 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/XListEntryListener.idl | 92 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/XListEntrySink.idl | 71 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/XListEntrySource.idl | 103 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/XValueBinding.idl | 101 | ||||
| -rw-r--r-- | offapi/drafts/com/sun/star/form/makefile.mk | 52 |
8 files changed, 634 insertions, 0 deletions
diff --git a/offapi/drafts/com/sun/star/form/IncompatibleTypesException.idl b/offapi/drafts/com/sun/star/form/IncompatibleTypesException.idl new file mode 100644 index 000000000000..ec784aa7c2bb --- /dev/null +++ b/offapi/drafts/com/sun/star/form/IncompatibleTypesException.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_IncompatibleTypesException_idl__ +#define __drafts_com_sun_star_form_IncompatibleTypesException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +//============================================================================= + +/** thrown to indicate that the types of an <type>XValueBinding</type> and + an <type>XBindableValue</type> are incompatible + + @deprecated + This exception is superseeded by <type scope="com::sun::star::form::binding">IncompatibleTypesException</type> +*/ +exception IncompatibleTypesException: com::sun::star::uno::Exception +{ +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/drafts/com/sun/star/form/ListEntryEvent.idl b/offapi/drafts/com/sun/star/form/ListEntryEvent.idl new file mode 100644 index 000000000000..9f7b8443f7da --- /dev/null +++ b/offapi/drafts/com/sun/star/form/ListEntryEvent.idl @@ -0,0 +1,77 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_ListEntryEvent_idl__ +#define __drafts_com_sun_star_form_ListEntryEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +//============================================================================= + +/** specifies the event which is notified when a change in a string entry + list occured + + @see XListEntrySource + @see XListEntryListener + + @deprecated + This structure is superseeded by <type scope="com::sun::star::form::binding">ListEntryEvent</type> +*/ +struct ListEntryEvent : com::sun::star::lang::EventObject +{ + /** denotes the position where a change occured. + + <p>The concrete semantics of the value depends on the concrete + event being notified.</p> + */ + long Position; + + /** denotes the number of changed entries, in case a change of + an entry <em>range</em> is being notified. + */ + long Count; + + /** denotes the changed entries + + <p>The concrete semantics of the value depends on the concrete + event being notified.</p> + */ + sequence< string > + Entries; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/XBindableValue.idl b/offapi/drafts/com/sun/star/form/XBindableValue.idl new file mode 100644 index 000000000000..fafb1edda83d --- /dev/null +++ b/offapi/drafts/com/sun/star/form/XBindableValue.idl @@ -0,0 +1,81 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_XBindableValue_idl__ +#define __drafts_com_sun_star_form_XBindableValue_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __drafts_com_sun_star_form_IncompatibleTypesException_idl__ +#include <drafts/com/sun/star/form/IncompatibleTypesException.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +interface XValueBinding; + +//============================================================================= + +/** specifies support for being bound to an external value + + @see XValueBinding + + @deprecated + This interface is superseeded by <type scope="com::sun::star::form::binding">XBindableValue</type> +*/ +interface XBindableValue : com::sun::star::uno::XInterface +{ + /** sets an external instance which controls the value of the component + + <p>Any previously active binding will be revoked. There can be only one!</p> + + @param XValueBinding + the new binding which is to be used by the component. May be <NULL/>, + in this case only the current binding is revoked. + + @throws <type>IncompatibleTypesException</type> + if the new binding (provided it's not <NULL/>) supports only types + which are incompatible with the types of the bindable component. + */ + void setValueBinding( [in] XValueBinding aBinding ) + raises ( IncompatibleTypesException ); + + /** retrieves the external instance which currently controls the value of the + component + */ + XValueBinding + getValueBinding( ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/XListEntryListener.idl b/offapi/drafts/com/sun/star/form/XListEntryListener.idl new file mode 100644 index 000000000000..e9e49d799d26 --- /dev/null +++ b/offapi/drafts/com/sun/star/form/XListEntryListener.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_XListEntryListener_idl__ +#define __drafts_com_sun_star_form_XListEntryListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif +#ifndef __drafts_com_sun_star_form_ListEntryEvent_idl__ +#include <drafts/com/sun/star/form/ListEntryEvent.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +//============================================================================= + +/** specifies a listener for changes in a string entry list + + @deprecated + This interface is superseeded by <type scope="com::sun::star::form::binding">XListEntryListener</type> +*/ +interface XListEntryListener : com::sun::star::lang::XEventListener +{ + /** notifies the listener that a single entry in the list has change + + @param Source + is the event describing the change. The <member>ListEntryEvent::Position</member> + member denotes the position of the changed entry, the first (and only) element + of the <member>ListEntryEvent::Entries</member> member denotes the new string + */ + void entryChanged( [in] ListEntryEvent Source ); + + /** notifies the listener that a range of entries has been inserted into the list + + @param Source + is the event describing the change. The <member>ListEntryEvent::Position</member> + member denotes the position of the first inserted entry, the + <member>ListEntryEvent::Entries</member> member contains the strings which have + been inserted. + */ + void entryRangeInserted( [in] ListEntryEvent Source ); + + /** notifies the listener that a range of entries has been removed from the list + + @param Source + is the event describing the change. The <member>ListEntryEvent::Position</member> + member denotes the position of the first removed entry, the + <member>ListEntryEvent::Count</member> member the number of removed entries. + */ + void entryRangeRemoved( [in] ListEntryEvent Source ); + + /** notifies the listener that all entries of the list have changed. + + <p>The listener should retrieve the complete new list by calling the + <member>XListEntrySource::getAllListEntries</member> method of the event source + (which is denoted by <member scope="com::sun::star::lang">EventObject::Source</member>). + */ + void allEntriesChanged( [in] com::sun::star::lang::EventObject Source ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/XListEntrySink.idl b/offapi/drafts/com/sun/star/form/XListEntrySink.idl new file mode 100644 index 000000000000..3cd163189c1d --- /dev/null +++ b/offapi/drafts/com/sun/star/form/XListEntrySink.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_XListEntrySink_idl__ +#define __drafts_com_sun_star_form_XListEntrySink_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +interface XListEntrySource; + +//============================================================================= + +/** specifies support for indirect manipulation of of a string list + + @deprecated + This interface is superseeded by <type scope="com::sun::star::form::binding">XListEntrySink</type> +*/ +interface XListEntrySink : com::sun::star::uno::XInterface +{ + /** sets the new source for the list entries of the component + + <p>The list represented by this component will be cleared, and initially + filled with the entries from the new list source.</p> + + @param Source + the new source for the list entries. May be <NULL/>, in this + case, the current source is revoked. + */ + void setListEntrySource( [in] XListEntrySource Source ); + + /** retrieves the current source for the list entries of the component. + */ + XListEntrySource + getListEntrySource( ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/XListEntrySource.idl b/offapi/drafts/com/sun/star/form/XListEntrySource.idl new file mode 100644 index 000000000000..095b8a703d5a --- /dev/null +++ b/offapi/drafts/com/sun/star/form/XListEntrySource.idl @@ -0,0 +1,103 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_XListEntrySource_idl__ +#define __drafts_com_sun_star_form_XListEntrySource_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_lang_NullPointerException_idl__ +#include <com/sun/star/lang/NullPointerException.idl> +#endif +#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +interface XListEntryListener; + +//============================================================================= + +/** specifies a source of string list entries + + <p>The interface supports foreign components which actively retrieve list entries, + as well as components which want to passively being notified of changes in the list.</p> + + @see XListEntrySink + + @deprecated + This interface is superseeded by <type scope="com::sun::star::form::binding">XListEntrySource</type> +*/ +interface XListEntrySource : com::sun::star::uno::XInterface +{ + /** retrieves the number of entries in the list + */ + long getListEntryCount( ); + + /** provides access to a single list entry + + @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> + if the given position does not denote a valid index in the list + + @see getListEntryCount + */ + string getListEntry( [in] long Position ) + raises( com::sun::star::lang::IndexOutOfBoundsException ); + + /** provides access to the entirety of all list entries + */ + sequence< string > + getAllListEntries( ); + + /** adds a listener which will be notified about changes in the list + reflected by the component. + + @throws <type scope="com::sun::star::lang">NullPointerException</type> + if the given listener is <NULL/> + */ + void addListEntryListener( [in] XListEntryListener Listener ) + raises( com::sun::star::lang::NullPointerException ); + + /** revokes the given listener from the list of components which will + be notfiied about changes in the entry list. + + @throws <type scope="com::sun::star::lang">NullPointerException</type> + if the given listener is <NULL/> + */ + void removeListEntryListener( [in] XListEntryListener Listener ) + raises( com::sun::star::lang::NullPointerException ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/XValueBinding.idl b/offapi/drafts/com/sun/star/form/XValueBinding.idl new file mode 100644 index 000000000000..a62c164ebfce --- /dev/null +++ b/offapi/drafts/com/sun/star/form/XValueBinding.idl @@ -0,0 +1,101 @@ +/************************************************************************* + * + * 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 __drafts_com_sun_star_form_XValueBinding_idl__ +#define __drafts_com_sun_star_form_XValueBinding_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_lang_NoSupportException_idl__ +#include <com/sun/star/lang/NoSupportException.idl> +#endif +#ifndef __drafts_com_sun_star_form_IncompatibleTypesException_idl__ +#include <drafts/com/sun/star/form/IncompatibleTypesException.idl> +#endif + +//============================================================================= + +module drafts { module com { module sun { module star { module form { + +//============================================================================= + +/** specifies a binding to a value which can be read and written. + + @deprecated + This interface is superseeded by <type scope="com::sun::star::form::binding">XValueBinding</type> +*/ +interface XValueBinding : com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** determines the types which are supported by this binding for value exchange + + @see supportsType + */ + sequence< type > + getSupportedValueTypes( ); + + /** determines whether a given type is supported by this binding for value exchange + + <p>Calling this method is equal to calling <member>getSupportedValueTypes</member>, + and looking up the given type in the resulting type sequence.</p> + + @see getSupportedValueTypes + */ + boolean supportsType( [in] type aType ); + + /** retrieves the current value + + @throws <type>IncompatibleTypesException</type> + if the requested value type is not supported by the binding + @see getSupportedValueTypes + @see supportsType + */ + any getValue( [in] type aType ) + raises( IncompatibleTypesException ); + + /** sets the current value + + @throws <type>IncompatibleTypesException</type> + if the given value type is not supported by the binding + @throws <type scope="com::sun::star::lang">NoSupportException</type> + if the value currently cannot be changed (e.g. because it's readonly), + or if the binding in general does not support write access to it's binding + + @see getSupportedValueTypes + @see supportsType + @see ValueBinding + */ + void setValue( [in] any aValue ) + raises( IncompatibleTypesException, com::sun::star::lang::NoSupportException ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/drafts/com/sun/star/form/makefile.mk b/offapi/drafts/com/sun/star/form/makefile.mk new file mode 100644 index 000000000000..c5f68e0fe2b5 --- /dev/null +++ b/offapi/drafts/com/sun/star/form/makefile.mk @@ -0,0 +1,52 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=dcssform +PACKAGE=drafts$/com$/sun$/star$/form + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + IncompatibleTypesException.idl \ + ListEntryEvent.idl \ + XBindableValue.idl \ + XValueBinding.idl \ + XListEntrySink.idl \ + XListEntrySource.idl \ + XListEntryListener.idl \ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |