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