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#ifndef __com_sun_star_embed_XVisualObject_idl__ 24cdf0e10cSrcweir#define __com_sun_star_embed_XVisualObject_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_awt_Size_idl__ 31cdf0e10cSrcweir#include <com/sun/star/awt/Size.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_embed_VisualRepresentation_idl__ 35cdf0e10cSrcweir#include <com/sun/star/embed/VisualRepresentation.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_embed_WrongStateException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/embed/WrongStateException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweir module com { module sun { module star { module embed { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir/** represents common visualisation functionality for embedded objects. 53cdf0e10cSrcweir */ 54cdf0e10cSrcweirpublished interface XVisualObject: ::com::sun::star::uno::XInterface 55cdf0e10cSrcweir{ 56cdf0e10cSrcweir //------------------------------------------------------------------------- 57cdf0e10cSrcweir /** sets the size of object's visual area. 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p> 60cdf0e10cSrcweir The size must be provided in logical units according to map mode the 61cdf0e10cSrcweir object communicates in. 62cdf0e10cSrcweir </p> 63cdf0e10cSrcweir 64cdf0e10cSrcweir <p> 65cdf0e10cSrcweir If an object is inplace- or ui-active the method must not initiate 66cdf0e10cSrcweir repainting itself. 67cdf0e10cSrcweir </p> 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param nAspect 70cdf0e10cSrcweir the aspect specifying the form of object representation. 71cdf0e10cSrcweir Can take values from <type>Aspects</type> constant set. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @param aSize 74cdf0e10cSrcweir the new size of the visual area 75cdf0e10cSrcweir 76cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 77cdf0e10cSrcweir one of arguments is illegal 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws ::com::sun::star::embed::WrongStateException 80cdf0e10cSrcweir the object is in wrong state 81cdf0e10cSrcweir 82cdf0e10cSrcweir @throws ::com::sun::star::uno::Exception 83cdf0e10cSrcweir the object failed to resize 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir void setVisualAreaSize( [in] hyper nAspect, 86cdf0e10cSrcweir [in] ::com::sun::star::awt::Size aSize ) 87cdf0e10cSrcweir raises( ::com::sun::star::lang::IllegalArgumentException, 88cdf0e10cSrcweir ::com::sun::star::embed::WrongStateException, 89cdf0e10cSrcweir ::com::sun::star::uno::Exception ); 90cdf0e10cSrcweir 91cdf0e10cSrcweir //------------------------------------------------------------------------- 92cdf0e10cSrcweir /** gets the size of object's visual area. 93cdf0e10cSrcweir 94cdf0e10cSrcweir <p> 95cdf0e10cSrcweir The size must be provided in logical units according to map mode the 96cdf0e10cSrcweir object communicates in. 97cdf0e10cSrcweir </p> 98cdf0e10cSrcweir 99cdf0e10cSrcweir @param nAspect 100cdf0e10cSrcweir the aspect specifying the form of object representation. 101cdf0e10cSrcweir Can take values from <type>Aspects</type> constant set. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @return 104cdf0e10cSrcweir the size of visual area 105cdf0e10cSrcweir 106cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 107cdf0e10cSrcweir one of arguments is illegal 108cdf0e10cSrcweir 109cdf0e10cSrcweir @throws ::com::sun::star::embed::WrongStateException 110cdf0e10cSrcweir the object is in wrong state 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir ::com::sun::star::awt::Size getVisualAreaSize( [in] hyper nAspect ) 113cdf0e10cSrcweir raises( ::com::sun::star::lang::IllegalArgumentException, 114cdf0e10cSrcweir ::com::sun::star::embed::WrongStateException, 115cdf0e10cSrcweir ::com::sun::star::uno::Exception ); 116cdf0e10cSrcweir 117cdf0e10cSrcweir //------------------------------------------------------------------------ 118cdf0e10cSrcweir /** retrieves visual representation of the object in preferable format. 119cdf0e10cSrcweir 120cdf0e10cSrcweir <p> 121cdf0e10cSrcweir If the object persistance entry contains cached visual representation 122cdf0e10cSrcweir then it can be retrieved by using this method even in loaded state. 123cdf0e10cSrcweir </p> 124cdf0e10cSrcweir 125cdf0e10cSrcweir @param nAspect 126cdf0e10cSrcweir the aspect the representation is requested for. 127cdf0e10cSrcweir Can take values from <type>Aspects</type> constant set. 128cdf0e10cSrcweir 129cdf0e10cSrcweir @return 130cdf0e10cSrcweir the visual representation of the object in the default format and 131cdf0e10cSrcweir the format 132cdf0e10cSrcweir 133cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 134cdf0e10cSrcweir one of arguments is illegal 135cdf0e10cSrcweir 136cdf0e10cSrcweir @throws ::com::sun::star::embed::WrongStateException 137cdf0e10cSrcweir the object is in wrong state 138cdf0e10cSrcweir 139cdf0e10cSrcweir @throws ::com::sun::star::uno::Exception 140cdf0e10cSrcweir in case of problems 141cdf0e10cSrcweir 142cdf0e10cSrcweir */ 143cdf0e10cSrcweir VisualRepresentation getPreferredVisualRepresentation( [in] hyper nAspect ) 144cdf0e10cSrcweir raises( ::com::sun::star::lang::IllegalArgumentException, 145cdf0e10cSrcweir ::com::sun::star::embed::WrongStateException, 146cdf0e10cSrcweir ::com::sun::star::uno::Exception ); 147cdf0e10cSrcweir 148cdf0e10cSrcweir 149cdf0e10cSrcweir //------------------------------------------------------------------------- 150cdf0e10cSrcweir /** retrieves map mode the object communicates in. 151cdf0e10cSrcweir 152cdf0e10cSrcweir @param nAspect 153cdf0e10cSrcweir the aspect the map mode is requested for. 154cdf0e10cSrcweir Can take values from <type>Aspects</type> constant set. 155cdf0e10cSrcweir 156cdf0e10cSrcweir @return 157cdf0e10cSrcweir the map mode the object communicates in, it can take values from 158cdf0e10cSrcweir <type>EmbedMapUnits</type> constant 159cdf0e10cSrcweir 160cdf0e10cSrcweir @throws ::com::sun::star::embed::WrongStateException 161cdf0e10cSrcweir the object is in wrong state 162cdf0e10cSrcweir 163cdf0e10cSrcweir @throws ::com::sun::star::uno::Exception 164cdf0e10cSrcweir in case of problems 165cdf0e10cSrcweir */ 166cdf0e10cSrcweir long getMapUnit( [in] hyper nAspect ) 167cdf0e10cSrcweir raises( ::com::sun::star::uno::Exception ); 168cdf0e10cSrcweir}; 169cdf0e10cSrcweir 170cdf0e10cSrcweir//============================================================================= 171cdf0e10cSrcweir 172cdf0e10cSrcweir}; }; }; }; 173cdf0e10cSrcweir 174cdf0e10cSrcweir#endif 175cdf0e10cSrcweir 176