/* -*- 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 .
*/
This component is a special one, which doesn't provide a controller nor a model. It supports the following features: - Drag & Drop - Key Accelerators - Simple Menu - Progress Bar - Background
*/ class BackingComp : public css::lang::XTypeProvider
, public css::lang::XServiceInfo
, public css::lang::XInitialization
, public css::frame::XController // => XComponent
, public css::awt::XKeyListener // => XEventListener
, public css::frame::XDispatchProvider
, public css::frame::XDispatch
, public ::cppu::OWeakObject
{ private: /** reference to the component window. */
css::uno::Reference< css::awt::XWindow > m_xWindow;
/** the owner frame of this component. */
css::uno::Reference< css::frame::XFrame > m_xFrame;
/** return information about supported interfaces.
Some interfaces are supported by his class directly, but some other ones are used by aggregation. An instance of this class must provide some window interfaces. But it must represent a VCL window behind such interfaces too! So we use an internal saved window member to ask it for its interfaces and return it. But we must be aware then, that it can be destroyed from outside too ...
@param aType describe the required interface type
@return An Any holding the instance, which provides the queried interface. Note: There exist two possible results ... this instance itself and her window member!
*/
// then look for supported window interfaces // Note: They exist only, if this instance was initialized // with a valid window reference. It's aggregation on demand ... if (!aResult.hasValue())
{ /* SAFE { */
SolarMutexGuard aGuard; if (m_xWindow.is())
aResult = m_xWindow->queryInterface(aType); /* } SAFE */
}
// look for XWeak and XInterface if (!aResult.hasValue())
aResult = OWeakObject::queryInterface(aType);
/** return collection about all supported interfaces.
Optimize this method ! We initialize a static variable only one time. And we don't must use a mutex at every call! For the first call; pTypeCollection is NULL - for the second call pTypeCollection is different from NULL!
@return A list of all supported interface types.
*/
/** create one unique Id for all instances of this class.
Optimize this method We initialize a static variable only one time. And we don't must use a mutex at every call! For the first call; pID is NULL - for the second call pID is different from NULL!
@return A byte array, which represent the unique id.
*/
We have to use the container window of this frame as parent window of our own component window. But it's not allowed to work with it really. May another component used it too. Currently we need it only to create our child component window and support it's interfaces inside our queryInterface() method. The user of us must have e.g. the XWindow interface of it to be able to call setComponent(xWindow,xController) at the frame!
// at this time XWindow isn't present at this instance! XWindow xBackingComp = (XWindow)UnoRuntime.queryInterface( XWindow.class, xBackingComp);
// attach controller to the frame // We will use its container window, to create // the component window. From now we offer the window interfaces! xBackingComp.attachFrame(xFrame);
// Our user can set us at the frame as new component xFrame.setComponent(xBackingWin, xBackingComp);
// But that had no effect to our view state. // We must be started to create our UI elements like e.g. menu, title, background ... XInitialization xBackingInit = (XInitialization)UnoRuntime.queryInterface( XInitialization.class, xBackingComp);
xBackingInit.initialize(lArgs); </listing>
@param xFrame reference to our new target frame
@throw css::uno::RuntimeException if the given frame reference is wrong or component window couldn't be created successfully. We throw it too, if we already attached to a frame. Because we don't support reparenting of our component window on demand!
*/
// check some required states if (m_xFrame.is()) throw css::uno::RuntimeException(
u"already attached"_ustr,
getXWeak());
if (!xFrame.is()) throw css::uno::RuntimeException(
u"invalid frame reference"_ustr,
getXWeak());
if (!m_xWindow.is()) return; // disposed
// safe the frame reference
m_xFrame = xFrame;
// initialize the component and its parent window
css::uno::Reference< css::awt::XWindow > xParentWindow = xFrame->getContainerWindow();
VclPtr< WorkWindow > pParent = static_cast<WorkWindow*>(VCLUnoHelper::GetWindow(xParentWindow));
VclPtr< vcl::Window > pWindow = VCLUnoHelper::GetWindow(m_xWindow);
// disable full screen mode of the frame! if (pParent && pParent->IsFullScreenMode())
{
pParent->ShowFullScreenMode(false);
pParent->SetMenuBarMode(MenuBarMode::Normal);
}
// create the menu bar for the backing component
css::uno::Reference< css::beans::XPropertySet > xPropSet(m_xFrame, css::uno::UNO_QUERY_THROW);
css::uno::Reference< css::frame::XLayoutManager > xLayoutManager;
xPropSet->getPropertyValue(u"LayoutManager"_ustr) >>= xLayoutManager; if (xLayoutManager.is())
{
xLayoutManager->lock();
xLayoutManager->createElement(u"private:resource/menubar/menubar"_ustr);
xLayoutManager->unlock();
}
if (pWindow)
{ // set help ID for our canvas
pWindow->SetHelpId(u"FWK_HID_BACKINGWINDOW"_ustr);
}
m_aInitialWindowMinSize = pParent->GetMinOutputSizePixel(); if (!m_aInitialWindowMinSize.Width())
m_aInitialWindowMinSize.AdjustWidth(1); if (!m_aInitialWindowMinSize.Height())
m_aInitialWindowMinSize.AdjustHeight(1);
If someone wishes to close this component, it must suspend the controller before. That will be a chance for it to disagree with that AND show any UI for a possible UI user.
@param bSuspend If it's set to sal_True this controller should be suspended. sal_False will resuspend it.
@return sal_True if the request could be finished successfully; sal_False otherwise.
*/
sal_Bool SAL_CALL BackingComp::suspend( /*IN*/ sal_Bool )
{ /* FIXME ... implemented by using default :-( */ returntrue;
}
/** callback from our window member.
Our internal saved window wish to die. It will be disposed from outside (may be the frame) and inform us. We must release its reference only here. Of course we check the given reference here and reject callback from unknown sources.
Note: deregistration as listener isn't necessary here. The broadcaster do it automatically.
@param aEvent describe the broadcaster of this callback
@throw css::uno::RuntimeException if the broadcaster doesn't represent the expected window reference.
*/
void SAL_CALL BackingComp::disposing( /*IN*/ const css::lang::EventObject& aEvent )
{ // Attention: don't free m_pAccExec here! see comments inside dtor and // keyPressed() for further details.
/* SAFE { */
SolarMutexGuard aGuard;
if (!aEvent.Source.is() || aEvent.Source!=m_xWindow || !m_xWindow.is()) throw css::uno::RuntimeException(
u"unexpected source or called twice"_ustr,
getXWeak());
m_xWindow.clear();
/* } SAFE */
}
/** kill this instance.
It can be called from our owner frame only. But there is no possibility to check the caller. We have to release all our internal used resources and die. From this point we can throw DisposedExceptions for every further interface request... but current implementation doesn't do so...
// stop listening at the window if (m_xWindow.is())
{
m_xWindow->removeEventListener(this);
m_xWindow->removeKeyListener(this);
m_xWindow.clear();
}
// forget all other used references
m_xFrame.clear();
/* } SAFE */
}
/** not supported.
@param xListener not used.
@throw css::uno::RuntimeException because the listener expect to be holded alive by this container. We must inform it about this unsupported feature.
*/
Inside attachFrame() we created our component window. But it was not allowed there, to initialize it. E.g. the menu must be set at the container window of the frame, which is our parent window. But may at that time another component used it. That's why our creator has to inform us, when it's time to initialize us really. Currently only calling of this method must be done. But further implementations can use special in parameter to configure this initialization...
@param lArgs currently not used
@throw css::uno::RuntimeException if some resources are missing Means if may be attachedFrame() wasn't called before.
*/
if (!m_xWindow.is()) throw css::uno::RuntimeException(
u"couldn't create component window"_ustr,
getXWeak());
// start listening for window disposing // It's set at our owner frame as component window later too. So it will may be disposed there ...
m_xWindow->addEventListener(static_cast< css::lang::XEventListener* >(this));
void SAL_CALL BackingComp::keyReleased( /*IN*/ const css::awt::KeyEvent& )
{ /* Attention Please use keyPressed() instead of this method. Otherwise it would be possible, that - a key input may be first switch to the backing mode - and this component register itself as key listener too - and it's first event will be a keyReleased() for the already well known event, which switched to the backing mode! So it will be handled twice! document => backing mode => exit app...
*/
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.
