diff options
Diffstat (limited to 'offapi/com/sun/star/frame/XFramesSupplier.idl')
| -rw-r--r-- | offapi/com/sun/star/frame/XFramesSupplier.idl | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl new file mode 100644 index 000000000000..04b37b13ac67 --- /dev/null +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -0,0 +1,165 @@ +/************************************************************************* + * + * $RCSfile: XFramesSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_frame_XFramesSupplier_idl__ +#define __com_sun_star_frame_XFramesSupplier_idl__ + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include <com/sun/star/frame/XFrame.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XFrames; + +//============================================================================= + +// DocMerge: empty anyway +[ uik(E2280108-33D6-11D1-AABE00A0-249D5590), ident( "XFramesSupplier", 1.0 ) ] +interface XFramesSupplier: XFrame +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getFrames + /** @returns + the collection of (sub-) frames which is represented by + a <type>FramesContainer</type>. + */ + XFrames getFrames(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getActiveFrame + /** @returns + the sub-<type>Frame</type> which is active within this frame. + + <p>This may be the frame itself. The active frame is defined as + the frame which contains (recursively) the window with the focus. + If no window within the frame contains the focus, this method + returns the last frame which had the focus. If no containing + window ever had the focus, the first frame within this frame is + returned. + */ + [const] XFrame getActiveFrame(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFramesSupplier::setActiveFrame + /** is called on activation of a direct sub-frame. + + + + <p>This method is only allowed to be called by a sub-frame according to + + + + + + or + + + + + + . After this call + + + + + + will return the + frame specified by <var>xFrame</var>. + + </p> + <p>In general this method first calls the method + + + + + + at the creator frame + with <var>this</var> as the current argument. Then it broadcasts + the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>.</p> + */ + void setActiveFrame( [in] XFrame xFrame ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif |