offapi/com/sun/star/awt/XView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XView.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XView_idl__
  31 #define __com_sun_star_awt_XView_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XGraphics_idl__
  38 #include <com/sun/star/awt/XGraphics.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Size_idl__
  42 #include <com/sun/star/awt/Size.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** makes it possible to attach an oputput device to the object.
  53
  54     <p>This kind of object is called view-object.</p>
  55  */
  56 published interface XView: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** sets the output device.
  61      */
  62     boolean setGraphics( [in] com::sun::star::awt::XGraphics aDevice );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** returns the output device which was set using the method
  67         <member>XView::setGraphics</member>.
  68      */
  69     com::sun::star::awt::XGraphics getGraphics();
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** returns the size of the object in device units.
  74
  75         <p>A device must be set before.</p>
  76      */
  77     com::sun::star::awt::Size getSize();
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** draws the object at the specified position.
  82
  83         <p>If the output should be clipped, the caller has to set the
  84         clipping region.</p>
  85      */
  86     [oneway] void draw( [in] long nX,
  87              [in] long nY );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** sets the zoom factor.
  92
  93         <p>The zoom factor only affects the content of the view, not the size.</p>
  94      */
  95     [oneway] void setZoom( [in] float fZoomX,
  96              [in] float fZoomY );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif