/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_frame_XFrame_idl__
#define __com_sun_star_frame_XFrame_idl__
#include
A frame can be (it's not a must!) a part of a frame tree. If not this frame won't be
accessible by using the API. This mode make sense for previews.
The root node of the tree can be a Desktop implementation.
This window will be used as parent for the component window and to support
some UI relevant features of the frame service.
Note: Re-parenting mustn't supported by a real frame implementation!
It's designed for initializing - not for setting.
This frame will take over ownership of the window referred from
xWindow. Thus, the previous owner is not allowed to
dispose this window anymore.
Normally this is used as the parent window of the
component window.
Only the creator is allowed to call this method.
But creator doesn't mean the implementation which creates this instance ...
it means the parent frame of the frame hierarchy.
Because; normally a frame should be created by using the API
and is necessary for searches inside the tree (e.g.
Normally the name of the frame is set initially (e.g. by the creator).
The name of a frame will be used for identifying it if a frame search was started.
These searches can be forced by:
Note: Special targets like "_blank", "_self" etc. are not allowed.
That's why frame names shouldn't start with a sign "_".
Frames may contain other frames (e.g., a frameset) and may be contained in other frames. This hierarchy is searched with this method. First some special names are taken into account, i.e. "", "_self", "_top", "_blank" etc. SearchFlags is ignored when comparing these names with TargetFrameName; further steps are controlled by SearchFlags. If allowed, the name of the frame itself is compared with the desired one, and then ( again if allowed ) the method is called for all children of the frame. Finally may be called for the siblings and then for parent frame (if allowed).
List of special target names:
""/"_self" | address the starting frame itself |
"_parent" | address the direct parent frame only |
"_top" | address the top frame of this subtree of the frametree |
"_blank" | creates a new top frame |
If no frame with the given name is found, a new top frame is
created; if this is allowed by a special flag
In general a top frame is the frame which is a direct child of
a task frame or which does not have a parent. Possible frame searches must
stop the search at such a frame unless the flag
At first the frame sets itself as the active frame of its
creator by calling
Finally, most frames may grab the focus to one of its windows or forward the activation to a sub-frame.
@see XFrame::deactivate() @see XFrame::isActive() */ void activate(); /** is called by the creator frame when another sub-frame gets activated.
At first the frame deactivates its active sub-frame, if any.
Then broadcasts a FrameActionEvent with
A valid component window should be a child of the frame container window.
@param xController the controller of the new component or
Simple components may implement a
Note: Don't dispose this window - the frame is the owner of it.
@returns the current visible component in this frame
Note: Don't dispose it - the frame is the owner of it.
Use
According to a call to this interface, the frame calls
E.g., it is possible to determine instantiation/destruction and activation/deactivation of components.
@param xListener specifies the listener which will be informed @see XFrame::removeFrameActionListener() */ void addFrameActionListener( [in]XFrameActionListener xListener ); /** unregisters an event listener @param xListener specifies the listener which won't be informed any longer @see XFrame::addFrameActionListener() */ void removeFrameActionListener( [in] XFrameActionListener xListener ); }; }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */