diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/DDELinkInfo.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/DDELinkInfo.idl | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/DDELinkInfo.idl b/offapi/com/sun/star/sheet/DDELinkInfo.idl new file mode 100644 index 000000000000..b9df62f3cd70 --- /dev/null +++ b/offapi/com/sun/star/sheet/DDELinkInfo.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * 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_sheet_DDELinkInfo_idl__ +#define __com_sun_star_sheet_DDELinkInfo_idl__ + +#ifndef __com_sun_star_sheet_DDEItemInfo_idl__ +#include <com/sun/star/sheet/DDEItemInfo.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= +/** describes all items of a DDE connection used in formulas. + + <p>A DDE connection consists of the DDE service name, the DDE topic and a + list of DDE items which may contain results cached from the last update.</p> + + <p>The formula that would need this information for example would contain + <code>=[1]!'R1C1'</code> or <code>=[2]!'Sheet1.A1'</code> where + <em>[1]</em> is an external link with DDE service name "excel" and the + topic "X:\PATH\[FILE.XLSX]Sheet1", and <em>[2]</em> contains service + "soffice" and topic "file:///X:/PATH/FILE.ODS". The service name is stored + in <member>DDELinkInfo::Service</member>, the topic is stored in + <member>DDELinkInfo::Topic</member>. Note that if the DDE item contains + single quotes they are escaped by doubling them, as usual, for example + <code>=[2]!'''Sheet name''.A1'</code> in a "soffice" service.</p> + + @since OOo3.1 + */ +struct DDELinkInfo +{ + //------------------------------------------------------------------------- + /** The DDE service name. + */ + string Service; + + //------------------------------------------------------------------------- + /** The DDE topic. + */ + string Topic; + + //------------------------------------------------------------------------- + /** A list of DDE items. Each item may contain its results from the last + update. + */ + sequence< DDEItemInfo > Items; + +}; + +//============================================================================= + +}; }; }; }; + +#endif |