offapi/com/sun/star/embed/EmbedStates.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: EmbedStates.idl,v $
  10  * $Revision: 1.5 $
  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_embed_EmbedStates_idl__
  31 #define __com_sun_star_embed_EmbedStates_idl__
  32
  33
  34 //============================================================================
  35
  36 module com { module sun { module star { module embed {
  37
  38 //============================================================================
  39 /** This constant set contains possible states for
  40 <type>EmbeddedObject</type>.
  41 */
  42 constants EmbedStates
  43 {
  44     //------------------------------------------------------------------------
  45     /** "Loaded" - the persistent representation of the object is loaded in
  46         memory.
  47
  48         <p>
  49         The object is created and assigned with a persistent entry,
  50         and a view representation ( metafile and etc. ) can be retrieved
  51         ( if there is any ).
  52         </p>
  53      */
  54     const long LOADED = 0;
  55
  56     //------------------------------------------------------------------------
  57     /** "Running" - the object is connected and loaded.
  58
  59         <p>
  60         The object has a connection to the container client and a component
  61         loaded from persistent entry. In case of internal document it also
  62         means existing of document model that implements
  63         <type scope="com::sun::star::frame">XModel</type> interface.
  64         </p>
  65      */
  66     const long RUNNING = 1;
  67
  68     //------------------------------------------------------------------------
  69     /** "Active" - the object is activated in separate window
  70         ( outplace activation ).
  71      */
  72     const long ACTIVE = 2;
  73
  74     //------------------------------------------------------------------------
  75     /** "Inplace active" - the object has own window in the container's
  76         window.
  77
  78         <p>
  79         The object is activated and has it's own window in the container's
  80         window that allows object to process mouse events and control own
  81         rendering.
  82         </p>
  83      */
  84     const long INPLACE_ACTIVE = 3;
  85
  86     //------------------------------------------------------------------------
  87     /** "UI active" - the inplace active object that has user interface.
  88
  89         <p>
  90         The object is inplace active, allowed to have menues, toolbars,
  91         keyboard accelerators, and has the focus.
  92         </p>
  93      */
  94     const long UI_ACTIVE = 4;
  95 };
  96
  97 //============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102