offapi/com/sun/star/embed/XVisualObject.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_embed_XVisualObject_idl__
  20 #define __com_sun_star_embed_XVisualObject_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/Size.idl>
  24 #include <com/sun/star/embed/VisualRepresentation.idl>
  25 #include <com/sun/star/embed/WrongStateException.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module embed {
  31
  32 /** represents common visualization functionality for embedded objects.
  33  */
  34 published interface XVisualObject: ::com::sun::star::uno::XInterface
  35 {
  36     /** sets the size of object's visual area.
  37
  38         <p>
  39         The size must be provided in logical units according to map mode the
  40         object communicates in.
  41         </p>
  42
  43         <p>
  44         If an object is inplace- or ui-active the method must not initiate
  45         repainting itself.
  46         </p>
  47
  48         @param nAspect
  49             the aspect specifying the form of object representation.
  50             Can take values from Aspects constant set.
  51
  52         @param aSize
  53             the new size of the visual area
  54
  55         @throws ::com::sun::star::lang::IllegalArgumentException
  56             one of arguments is illegal
  57
  58         @throws ::com::sun::star::embed::WrongStateException
  59             the object is in wrong state
  60
  61         @throws ::com::sun::star::uno::Exception
  62             the object failed to resize
  63      */
  64     void setVisualAreaSize( [in] hyper nAspect,
  65                          [in] ::com::sun::star::awt::Size aSize )
  66         raises( ::com::sun::star::lang::IllegalArgumentException,
  67                 ::com::sun::star::embed::WrongStateException,
  68                 ::com::sun::star::uno::Exception );
  69
  70     /** gets the size of object's visual area.
  71
  72         <p>
  73         The size must be provided in logical units according to map mode the
  74         object communicates in.
  75         </p>
  76
  77         @param nAspect
  78             the aspect specifying the form of object representation.
  79             Can take values from Aspects constant set.
  80
  81         @return
  82             the size of visual area
  83
  84         @throws ::com::sun::star::lang::IllegalArgumentException
  85             one of arguments is illegal
  86
  87         @throws ::com::sun::star::embed::WrongStateException
  88             the object is in wrong state
  89      */
  90     ::com::sun::star::awt::Size getVisualAreaSize( [in] hyper nAspect )
  91         raises( ::com::sun::star::lang::IllegalArgumentException,
  92                 ::com::sun::star::embed::WrongStateException,
  93                 ::com::sun::star::uno::Exception );
  94
  95     /** retrieves visual representation of the object in preferable format.
  96
  97         <p>
  98         If the object persistence entry contains cached visual representation
  99         then it can be retrieved by using this method even in loaded state.
 100         </p>
 101
 102         @param nAspect
 103             the aspect the representation is requested for.
 104             Can take values from Aspects constant set.
 105
 106         @return
 107             the visual representation of the object in the default format and
 108             the format
 109
 110         @throws ::com::sun::star::lang::IllegalArgumentException
 111             one of arguments is illegal
 112
 113         @throws ::com::sun::star::embed::WrongStateException
 114             the object is in wrong state
 115
 116         @throws ::com::sun::star::uno::Exception
 117             in case of problems
 118
 119      */
 120     VisualRepresentation getPreferredVisualRepresentation( [in] hyper nAspect )
 121         raises( ::com::sun::star::lang::IllegalArgumentException,
 122                 ::com::sun::star::embed::WrongStateException,
 123                 ::com::sun::star::uno::Exception );
 124
 125
 126     /** retrieves map mode the object communicates in.
 127
 128         @param nAspect
 129             the aspect the map mode is requested for.
 130             Can take values from Aspects constant set.
 131
 132         @return
 133             the map mode the object communicates in, it can take values from
 134             EmbedMapUnits constant
 135
 136         @throws ::com::sun::star::embed::WrongStateException
 137             the object is in wrong state
 138
 139         @throws ::com::sun::star::uno::Exception
 140             in case of problems
 141      */
 142     long getMapUnit( [in] hyper nAspect )
 143         raises( ::com::sun::star::uno::Exception );
 144 };
 145
 146
 147 }; }; }; };
 148
 149 #endif
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */