#94968# IDL reviews merged

1 files changed, 106 insertions, 110 deletions

diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl
index be0366e66..8700905cc 100644
--- a/offapi/com/sun/star/frame/FrameAction.idl
+++ b/offapi/com/sun/star/frame/FrameAction.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: FrameAction.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -58,132 +58,128 @@
  *
  *
  ************************************************************************/
-#ifndef __com_sun_star_frame_FrameAction_idl__ 
-#define __com_sun_star_frame_FrameAction_idl__ 
- 
- 
-//============================================================================= 
- 
- module com {  module sun {  module star {  module frame {  
- 
-//============================================================================= 
- 
-// DocMerge from xml: enum com::sun::star::frame::FrameAction
-/** These are the events which can happen to the components in frames 
-    of the desktop.
+#ifndef __com_sun_star_frame_FrameAction_idl__
+#define __com_sun_star_frame_FrameAction_idl__
+
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module frame {
+
+//=============================================================================
+/** these are the events which can happen to the components in frames
+    of the desktop
+
+    <p>
+    Interest listener can get informations about loaded/realoed or unloaded
+    components into a <type>Frame</type>.
+    </p>
+
+    @see XFrame
+    @see XFrameActionListener
+    @see FrameActionEvent
  */
 enum FrameAction
-{ 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_ATTACHED
-    /** An event of this kind is broadcast whenever a component is
-        attached to a frame.
-        
-        <p>This is almost the same as the instantiation of the component
+{
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast whenever a component is
+        attached to a frame
+
+        <p>
+        This is almost the same as the instantiation of the component
         within that frame. The component is attached to the frame
-        immediately before this event is broadcast.</p>@see XFrame::activated
+        immediately before this event is broadcast.
+        </p>
+
+        @see XFrame::setComponent()
      */
-    COMPONENT_ATTACHED, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_DETACHING
-    /** An event of this kind is broadcast whenever a component is
-        detaching from a frame.
-    
-        <p>This is quite the same as the destruction of the component
+    COMPONENT_ATTACHED,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast whenever a component is
+        detaching from a frame
+
+        <p>
+        This is quite the same as the destruction of the component
         which was in that frame. At the moment when the event is broadcast
         the component is still attached to the frame but in the next
-        moment it won't.		
+        moment it won't.
         </p>
+
+        @see XFrame::setComponent()
      */
-    COMPONENT_DETACHING, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_REATTACHED
-    /** An event of this kind is broadcast whenever a component is
+    COMPONENT_DETACHING,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast whenever a component is
         attached to a new model.
-        
-        <p>In this case the component remains the same but operates
-        on a new model component.</p>
+
+        <p>
+        In this case the component remains the same but operates
+        on a new model component.
+        </p>
      */
-    COMPONENT_REATTACHED, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_ACTIVATED
-    /** An event of this kind is broadcast whenever a component gets
-        activated.
-        
-        <p>Activations are broacast from the top component which was
-        not active before, down to the inner most component.</p>@see XFrame::activated
+    COMPONENT_REATTACHED,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast whenever a component gets
+        activated
+
+        <p>
+        Activations are broacast from the top component which was
+        not active before, down to the inner most component.
+        </p>
+
+        @see XFrame::activate()
      */
-    FRAME_ACTIVATED, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_DEACTIVATING
-    /** An event of this kind is broadcasted immediately before the 
-        component is deactivated.
-        
-        <p>Deactivations are broadcast from the innermost component which
+    FRAME_ACTIVATED,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcasted immediately before the
+        component is deactivated
+
+        <p>
+        Deactivations are broadcast from the innermost component which
         does not stay active up to the outer most component which does not
-        stay active.</p>
-        @see XFrame::contextChanged
+        stay active.
+        </p>
+
+        @see XFrame::deactivate()
      */
-    FRAME_DEACTIVATING, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::CONTEXT_CHANGED
-    /** An event of this kind is broadcast whenever a component changes
+    FRAME_DEACTIVATING,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast whenever a component changes
         its internal context (i.e., the selection).
-        
-        <p>If the activation status within a frame changes, this counts as
+
+        <p>
+        If the activation status within a frame changes, this counts as
         a context change too.
         </p>
+
+        @see XFrame::contexChanged()
      */
-    CONTEXT_CHANGED, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_ACTIVATED
-    /** An event of this kind is broadcast by an active frame when it
+    CONTEXT_CHANGED,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast by an active frame when it
         is getting UI control (tool control).
+
+        @see XFrame::activate()
      */
-    FRAME_UI_ACTIVATED, 
- 
-    //------------------------------------------------------------------------- 
-     
-    // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_DEACTIVATING
-    /** An event of this kind is broadcast by an active frame when it
+    FRAME_UI_ACTIVATED,
+
+    //-------------------------------------------------------------------------
+    /** an event of this kind is broadcast by an active frame when it
         is losing UI control (tool control).
+
+        @see XFrame::deactivate()
      */
-    FRAME_UI_DEACTIVATING 
- 
-}; 
- 
-//============================================================================= 
- 
-}; }; }; };  
- 
-/*============================================================================= 
- 
-    $Log: not supported by cvs2svn $
-    Revision 1.3  2000/11/08 12:43:14  mi
-    moved from api
-    
-    Revision 1.1.1.1  2000/09/18 23:35:20  hjs
-    initial import
-    
-    Revision 1.5  2000/09/11 11:52:27  mi
-    documentation merged from XML
-     
-    Revision 1.1.1.1  1999/11/11 09:48:43  jsc 
-    new 
-     
- 
-=============================================================================*/ 
-#endif 
+    FRAME_UI_DEACTIVATING
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif