1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextContent_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_text_XTextContent_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XComponent_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XComponent.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextRange_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XTextRange.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski module com { module sun { module star { module text { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski/** enables objects to be inserted into a text and to provide their 46*b1cdbd2cSJim Jagielski location in a text once they are inserted into it. 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielskipublished interface XTextContent: com::sun::star::lang::XComponent 49*b1cdbd2cSJim Jagielski{ 50*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** is called when this object gets embedded in a text. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski <p>This acts like a multi-phase construction, thus the object may be 57*b1cdbd2cSJim Jagielski invalid until it is attached to a text position. In general, this method 58*b1cdbd2cSJim Jagielski is called from within 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski . 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski </p> 66*b1cdbd2cSJim Jagielski <p>Both text objects and text content objects may only be connected 67*b1cdbd2cSJim Jagielski to each other if they are created by the same component. When 68*b1cdbd2cSJim Jagielski implementing new components, this behaviour is deprecated.</p> 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski void attach( [in] com::sun::star::text::XTextRange xTextRange ) 71*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** @returns 76*b1cdbd2cSJim Jagielski the text range to which the content is attached. 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski <p>Note: The anchor of the actual implementation for text tables 79*b1cdbd2cSJim Jagielski does not have a position in the text. Thus that anchor can not be 80*b1cdbd2cSJim Jagielski used for some operation like <member>attach</member> for example or 81*b1cdbd2cSJim Jagielski <member scope="com::sun::star::text">insertTextContent</member> 82*b1cdbd2cSJim Jagielski or other function that require the object to have a position in the text.</p> 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski <p>The reason why a text table still needs an anchor is that for example 85*b1cdbd2cSJim Jagielski tables should be insertable via <member scope="com::sun::star::text">insertTextContent</member> 86*b1cdbd2cSJim Jagielski and that interface uses a parameter of that type.</p> 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski com::sun::star::text::XTextRange getAnchor(); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski}; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski//============================================================================= 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski}; }; }; }; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski#endif 97