offapi/com/sun/star/presentation/XSlideShowView.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: XSlideShowView.idl,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31 #ifndef __com_sun_star_presentation_XSlideShowView_idl__
  32 #define __com_sun_star_presentation_XSlideShowView_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_rendering_XSpriteCanvas_idl__
  38 #include <com/sun/star/rendering/XSpriteCanvas.idl>
  39 #endif
  40 #ifndef __com_sun_star_util_XModifyListener_idl__
  41 #include <com/sun/star/util/XModifyListener.idl>
  42 #endif
  43 #ifndef __com_sun_star_awt_XPaintListener_idl__
  44 #include <com/sun/star/awt/XPaintListener.idl>
  45 #endif
  46 #ifndef __com_sun_star_awt_XMouseListener_idl__
  47 #include <com/sun/star/awt/XMouseListener.idl>
  48 #endif
  49 #ifndef __com_sun_star_awt_XMouseMotionListener_idl__
  50 #include <com/sun/star/awt/XMouseMotionListener.idl>
  51 #endif
  52 #ifndef __com_sun_star_awt_Rectangle_idl__
  53 #include <com/sun/star/awt/Rectangle.idl>
  54 #endif
  55
  56 module com {  module sun {  module star {  module presentation {
  57
  58 /** View interface to display slideshow presentations on.<p>
  59
  60     This interface provides the necessary methods to enable an
  61     XSlideShow interface to display a presentation. The slideshow can
  62     be displayed simultaneously on multiple views<p>
  63
  64     @since OOo 2.4
  65  */
  66 interface XSlideShowView : ::com::sun::star::uno::XInterface
  67 {
  68     /** Get view canvas.<p>
  69
  70         This method gets the underlying XCanvas to display on this
  71         view.<p>
  72
  73         @return XSpriteCanvas to display on. Must be valid, and the
  74         same object, as long as this view is added to any slide show.
  75      */
  76     ::com::sun::star::rendering::XSpriteCanvas getCanvas();
  77
  78     /** This method clears the whole view area.
  79
  80         The slideshow uses this method to fully erase the view
  81         content. Since the slideshow has no notion of view size, this
  82         is the only reliable way to wholly clear the view.
  83      */
  84     void clear();
  85
  86     /** Query the current transformation matrix for this view.<p>
  87
  88            This method returns the transformation matrix of the
  89            view. When notified via the transformation change listener,
  90            the show will be displayed using the new transformation.<p>
  91
  92         @return the view transformation matrix. Note that the slide
  93         show itself will paint all slides as one-by-one boxes, one
  94         therefore has to at least provide a scaling at this matrix to
  95         blow this up to the desired device pixel size (640 times 480,
  96         or whatever size the output view has). Furthermore, the aspect
  97         ratio of the scaling should match that of the slides
  98         (otherwise, the slides will be scaled anisotrophically).
  99      */
 100     ::com::sun::star::geometry::AffineMatrix2D getTransformation();
 101
 102     /** Add a listener to get notified when the transformation matrix changes.<p>
 103
 104         This method registers a listener with the view, which will get
 105         called everytime the transformation matrix changes.<p>
 106
 107         @param xListener
 108         Listener interface to call when the transformation matrix changes.
 109      */
 110     void addTransformationChangedListener( [in] ::com::sun::star::util::XModifyListener xListener );
 111
 112     /** Revoke a previously registered transformation matrix change listener.<p>
 113
 114         @param xListener
 115         Listener interface to revoke from being called.
 116      */
 117     void removeTransformationChangedListener( [in] ::com::sun::star::util::XModifyListener xListener );
 118
 119     /** Add a listener to get notified when this view needs a repaint.<p>
 120
 121         This method registers a listener with the view, which will get
 122         called everytime the view needs an update of their screen
 123         representation.<p>
 124
 125         @param xListener
 126         Listener interface to call when the view needs a repaint.
 127      */
 128     void addPaintListener( [in] ::com::sun::star::awt::XPaintListener xListener );
 129
 130     /** Revoke a previously registered paint listener.<p>
 131
 132         @param xListener
 133         Listener interface to revoke from being called.
 134      */
 135     void removePaintListener( [in] ::com::sun::star::awt::XPaintListener xListener );
 136
 137     /** Add a mouse listener to the view.<p>
 138
 139         This method registers a listener with the view, which will get
 140         called everytime the mouse is clicked on the view.<p>
 141
 142         @param xListener
 143         Listener interface to call when the mouse is clicked on the view.
 144      */
 145     void addMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 146
 147     /** Revoke a previously registered mouse listener.<p>
 148
 149         @param xListener
 150         Listener interface to revoke from being called.
 151      */
 152     void removeMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 153
 154     /** Add a mouse motion listener to the view.<p>
 155
 156         This method registers a listener with the view, which will get
 157         called everytime the mouse is moved on the view.<p>
 158
 159         @param xListener
 160         Listener interface to call when the mouse is moved on the view.
 161      */
 162     void addMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 163
 164     /** Revoke a previously registered mouse move listener.<p>
 165
 166         @param xListener
 167         Listener interface to revoke from being called.
 168      */
 169     void removeMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 170
 171     /** Change the mouse cursor currently in effect.<p>
 172
 173         This method changes the mouse cursor currently in effect, for
 174         this view.<p>
 175
 176         @param nPointerShape
 177         New mouse cursor shape to display for this view. Must be from
 178         the ::com::sun::star::awt::SystemPointer constant group.
 179      */
 180     void setMouseCursor( [in] short nPointerShape );
 181
 182     /** Get rectangle defining area inside of canvas device which
 183     this slideshow view uses.
 184     */
 185     ::com::sun::star::awt::Rectangle getCanvasArea();
 186 };
 187
 188 }; }; }; };
 189
 190
 191 #endif