offapi/com/sun/star/presentation/PreviewView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_presentation_PreviewView_idl__
  28 #define __com_sun_star_presentation_PreviewView_idl__
  29
  30 #ifndef __com_sun_star_drawing_XDrawView_idl__
  31 #include <com/sun/star/drawing/XDrawView.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_Controller_idl__
  39 #include <com/sun/star/frame/Controller.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  43 #include <com/sun/star/lang/XServiceInfo.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  47 #include <com/sun/star/drawing/XDrawPage.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_awt_XWindow_idl__
  51 #include <com/sun/star/awt/XWindow.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module presentation {
  57
  58 //=============================================================================
  59
  60 /** This componend integrates a preview view to a slide show of a presentation
  61     document into the desktop.
  62
  63     @since OOo 1.1.2
  64  */
  65 published service PreviewView
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** this services offers the  integration of this component into the
  70         desktop.
  71     */
  72     service com::sun::star::frame::Controller;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** lets you access the window for this view
  77     */
  78     interface com::sun::star::awt::XWindow;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** lets you set/get the current page displayed by this
  83         view.
  84      */
  85     interface com::sun::star::drawing::XDrawView;
  86
  87     //-------------------------------------------------------------------------
  88
  89
  90     /** lets you access the properties of this service.
  91      */
  92     interface com::sun::star::beans::XPropertySet;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** provides the names of the services implemented by
  97                 this instance.
  98      */
  99     interface com::sun::star::lang::XServiceInfo;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** This is the drawing page that is currently visible.
 104      */
 105     [property] com::sun::star::drawing::XDrawPage CurrentPage;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** This is the area that is currently visible.
 110      */
 111     [readonly, property] com::sun::star::awt::Rectangle VisibleArea;
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif