1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSheetLinkable_idl__
25cdf0e10cSrcweir#define __com_sun_star_sheet_XSheetLinkable_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_sheet_SheetLinkMode_idl__
32cdf0e10cSrcweir#include <com/sun/star/sheet/SheetLinkMode.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** enables a sheet to refer to another sheet in a different document.
42cdf0e10cSrcweir
43cdf0e10cSrcweir	<p>To insert a sheet link, the sheet used as linked sheet has to exist
44cdf0e10cSrcweir	already. The method <member>XSheetLinkable::link</member> creates a
45cdf0e10cSrcweir	<type>SheetLink</type> object in the document's <type>SheetLinks</type>
46cdf0e10cSrcweir	collection and links the sheet to the specified external sheet.</p>
47cdf0e10cSrcweir
48cdf0e10cSrcweir	@see com::sun::star::sheet::SheetLinks
49cdf0e10cSrcweir	@see com::sun::star::sheet::SheetLink
50cdf0e10cSrcweir
51cdf0e10cSrcweir	@deprecated
52cdf0e10cSrcweir */
53cdf0e10cSrcweirpublished interface XSheetLinkable: com::sun::star::uno::XInterface
54cdf0e10cSrcweir{
55cdf0e10cSrcweir	//-------------------------------------------------------------------------
56cdf0e10cSrcweir
57cdf0e10cSrcweir	/** returns the link mode of the spreadsheet.
58cdf0e10cSrcweir
59cdf0e10cSrcweir		<p>If the returned value is <const>SheetLinkMode::NORMAL</const>,
60cdf0e10cSrcweir		formulas are copied. With <const>SheetLinkMode::VALUE</const>,
61cdf0e10cSrcweir		only results of formulas are used.</p>
62cdf0e10cSrcweir	 */
63cdf0e10cSrcweir	com::sun::star::sheet::SheetLinkMode getLinkMode();
64cdf0e10cSrcweir
65cdf0e10cSrcweir	//-------------------------------------------------------------------------
66cdf0e10cSrcweir
67cdf0e10cSrcweir	/** enables the linking of the sheet and controls whether formulas
68cdf0e10cSrcweir		are copied.
69cdf0e10cSrcweir
70cdf0e10cSrcweir		@param nLinkMode
71cdf0e10cSrcweir			the value specifying the link mode for this spreadsheet.
72cdf0e10cSrcweir
73cdf0e10cSrcweir			<p>If the value is <const>SheetLinkMode::NORMAL</const>,
74cdf0e10cSrcweir			formulas are copied.  With <const>SheetLinkMode::VALUE</const>,
75cdf0e10cSrcweir			only results of formulas are used.</p>
76cdf0e10cSrcweir	 */
77cdf0e10cSrcweir	void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );
78cdf0e10cSrcweir
79cdf0e10cSrcweir	//-------------------------------------------------------------------------
80cdf0e10cSrcweir
81cdf0e10cSrcweir	/** returns the target URL of the link.
82cdf0e10cSrcweir	 */
83cdf0e10cSrcweir	string getLinkUrl();
84cdf0e10cSrcweir
85cdf0e10cSrcweir	//-------------------------------------------------------------------------
86cdf0e10cSrcweir
87cdf0e10cSrcweir	/** sets the target URL of the link.
88cdf0e10cSrcweir
89cdf0e10cSrcweir		<p>A <type>SheetLink</type> object with the same file name must
90cdf0e10cSrcweir		exist already or the link will not work.</p>
91cdf0e10cSrcweir	 */
92cdf0e10cSrcweir	void setLinkUrl( [in] string aLinkUrl );
93cdf0e10cSrcweir
94cdf0e10cSrcweir	//-------------------------------------------------------------------------
95cdf0e10cSrcweir
96cdf0e10cSrcweir	/** returns the sheet name of the sheet in the source document.
97cdf0e10cSrcweir	 */
98cdf0e10cSrcweir	string getLinkSheetName();
99cdf0e10cSrcweir
100cdf0e10cSrcweir	//-------------------------------------------------------------------------
101cdf0e10cSrcweir
102cdf0e10cSrcweir	/** sets the name of the linked sheet in the source document.
103cdf0e10cSrcweir
104cdf0e10cSrcweir		<p>This method sets the sheet name in the <type>SheetLink</type>
105cdf0e10cSrcweir		object, it does not modify the sheet name in the source document.</p>
106cdf0e10cSrcweir	 */
107cdf0e10cSrcweir	void setLinkSheetName( [in] string aLinkSheetName );
108cdf0e10cSrcweir
109cdf0e10cSrcweir	//-------------------------------------------------------------------------
110cdf0e10cSrcweir
111cdf0e10cSrcweir	/** links the sheet to another sheet in another document.
112cdf0e10cSrcweir
113cdf0e10cSrcweir		<p>A <type>SheetLink</type> object is created if it does not exist,
114cdf0e10cSrcweir		and the link mode, the URL of the linked document and the linked
115cdf0e10cSrcweir		sheet name are set.</p>
116cdf0e10cSrcweir	 */
117cdf0e10cSrcweir	void link( [in] string aUrl,
118cdf0e10cSrcweir			 [in] string aSheetName,
119cdf0e10cSrcweir			 [in] string aFilterName,
120cdf0e10cSrcweir			 [in] string aFilterOptions,
121cdf0e10cSrcweir			 [in] com::sun::star::sheet::SheetLinkMode nMode );
122cdf0e10cSrcweir
123cdf0e10cSrcweir};
124cdf0e10cSrcweir
125cdf0e10cSrcweir//=============================================================================
126cdf0e10cSrcweir
127cdf0e10cSrcweir}; }; }; };
128cdf0e10cSrcweir
129cdf0e10cSrcweir#endif
130cdf0e10cSrcweir
131