offapi/com/sun/star/awt/PaintEvent.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: PaintEvent.idl,v $
  10  * $Revision: 1.11 $
  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_PaintEvent_idl__
  31 #define __com_sun_star_awt_PaintEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Rectangle_idl__
  38 #include <com/sun/star/awt/Rectangle.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** specifies the paint event for a component.
  49
  50     <p>This event is a special type which is used to ensure that
  51     paint/update method calls are serialized along with the other
  52     events delivered from the event queue.</p>
  53
  54     @see WindowEvent
  55  */
  56 published struct PaintEvent: com::sun::star::lang::EventObject
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** contains the rectangle area which needs to be repainted.
  61      */
  62     com::sun::star::awt::Rectangle UpdateRect;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** contains the number of paint events that follows this event if
  67         it is a multiple PaintEvent. You can collect the PaintEvent
  68         until Count is zero.
  69      */
  70     short Count;
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif