offapi/com/sun/star/presentation/PreviewView.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: PreviewView.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_presentation_PreviewView_idl__
  31 #define __com_sun_star_presentation_PreviewView_idl__
  32
  33 #ifndef __com_sun_star_drawing_XDrawView_idl__
  34 #include <com/sun/star/drawing/XDrawView.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_Controller_idl__
  42 #include <com/sun/star/frame/Controller.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  46 #include <com/sun/star/lang/XServiceInfo.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  50 #include <com/sun/star/drawing/XDrawPage.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_XWindow_idl__
  54 #include <com/sun/star/awt/XWindow.idl>
  55 #endif
  56
  57 //=============================================================================
  58
  59  module com {  module sun {  module star {  module presentation {
  60
  61 //=============================================================================
  62
  63 /** This componend integrates a preview view to a slide show of a presentation
  64     document into the desktop.
  65
  66     @since OOo 1.1.2
  67  */
  68 published service PreviewView
  69 {
  70     //-------------------------------------------------------------------------
  71
  72     /** this services offers the  integration of this component into the
  73         desktop.
  74     */
  75     service com::sun::star::frame::Controller;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** lets you access the window for this view
  80     */
  81     interface com::sun::star::awt::XWindow;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** lets you set/get the current page displayed by this
  86         view.
  87      */
  88     interface com::sun::star::drawing::XDrawView;
  89
  90     //-------------------------------------------------------------------------
  91
  92
  93     /** lets you access the properties of this service.
  94      */
  95     interface com::sun::star::beans::XPropertySet;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** provides the names of the services implemented by
 100                 this instance.
 101      */
 102     interface com::sun::star::lang::XServiceInfo;
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** This is the drawing page that is currently visible.
 107      */
 108     [property] com::sun::star::drawing::XDrawPage CurrentPage;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** This is the area that is currently visible.
 113      */
 114     [readonly, property] com::sun::star::awt::Rectangle VisibleArea;
 115
 116 };
 117
 118 //=============================================================================
 119
 120 }; }; }; };
 121
 122 #endif