| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_text_XTextContent_idl__ |
| #define __com_sun_star_text_XTextContent_idl__ |
| |
| #ifndef __com_sun_star_lang_XComponent_idl__ |
| #include <com/sun/star/lang/XComponent.idl> |
| #endif |
| |
| #ifndef __com_sun_star_text_XTextRange_idl__ |
| #include <com/sun/star/text/XTextRange.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module text { |
| |
| //============================================================================= |
| |
| /** enables objects to be inserted into a text and to provide their |
| location in a text once they are inserted into it. |
| */ |
| published interface XTextContent: com::sun::star::lang::XComponent |
| { |
| //------------------------------------------------------------------------- |
| |
| /** is called when this object gets embedded in a text. |
| |
| |
| |
| <p>This acts like a multi-phase construction, thus the object may be |
| invalid until it is attached to a text position. In general, this method |
| is called from within |
| |
| |
| |
| |
| . |
| |
| </p> |
| <p>Both text objects and text content objects may only be connected |
| to each other if they are created by the same component. When |
| implementing new components, this behaviour is deprecated.</p> |
| */ |
| void attach( [in] com::sun::star::text::XTextRange xTextRange ) |
| raises( com::sun::star::lang::IllegalArgumentException ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** @returns |
| the text range to which the content is attached. |
| |
| <p>Note: The anchor of the actual implementation for text tables |
| does not have a position in the text. Thus that anchor can not be |
| used for some operation like <member>attach</member> for example or |
| <member scope="com::sun::star::text">insertTextContent</member> |
| or other function that require the object to have a position in the text.</p> |
| |
| <p>The reason why a text table still needs an anchor is that for example |
| tables should be insertable via <member scope="com::sun::star::text">insertTextContent</member> |
| and that interface uses a parameter of that type.</p> |
| */ |
| com::sun::star::text::XTextRange getAnchor(); |
| |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |