chart2/source/controller/main/ElementSelector.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "ElementSelector.hxx"
  21 #include <ObjectNameProvider.hxx>
  22 #include <ObjectHierarchy.hxx>
  23 #include <servicenames.hxx>
  24 #include <chartview/ExplicitValueProvider.hxx>
  25 #include <DrawViewWrapper.hxx>
  26 #include <ResId.hxx>
  27 #include <strings.hrc>
  28 #include <ObjectIdentifier.hxx>
  29
  30 #include <cppuhelper/supportsservice.hxx>
  31 #include <toolkit/helper/vclunohelper.hxx>
  32 #include <vcl/svapp.hxx>
  33
  34 #include <com/sun/star/chart2/XChartDocument.hpp>
  35 #include <com/sun/star/util/XURLTransformer.hpp>
  36 #include <com/sun/star/view/XSelectionSupplier.hpp>
  37
  38 namespace chart
  39 {
  40
  41 using namespace com::sun::star;
  42 using namespace com::sun::star::uno;
  43 using ::com::sun::star::uno::Any;
  44 using ::com::sun::star::uno::Reference;
  45 using ::com::sun::star::uno::Sequence;
  46
  47 namespace
  48 {
  49 static const char lcl_aServiceName[] = "com.sun.star.comp.chart.ElementSelectorToolbarController";
  50 }
  51
  52 SelectorListBox::SelectorListBox( vcl::Window* pParent, WinBits nStyle )
  53     : ListBox( pParent, nStyle )
  54     , m_bReleaseFocus( true )
  55 {
  56 }
  57
  58 void lcl_addObjectsToList( const ObjectHierarchy& rHierarchy, const  ObjectIdentifier & rParent, std::vector< ListBoxEntryData >& rEntries
  59                           , const sal_Int32 nHierarchyDepth, const Reference< chart2::XChartDocument >& xChartDoc )
  60 {
  61     ObjectHierarchy::tChildContainer aChildren( rHierarchy.getChildren(rParent) );
  62     for (auto const& child : aChildren)
  63     {
  64         ObjectIdentifier aOID = child;
  65         OUString aCID = aOID.getObjectCID();
  66         ListBoxEntryData aEntry;
  67         aEntry.OID = aOID;
  68         aEntry.UIName += ObjectNameProvider::getNameForCID( aCID, xChartDoc );
  69         aEntry.nHierarchyDepth = nHierarchyDepth;
  70         rEntries.push_back(aEntry);
  71         lcl_addObjectsToList( rHierarchy, aOID, rEntries, nHierarchyDepth+1, xChartDoc );
  72     }
  73 }
  74
  75 void SelectorListBox::SetChartController( const Reference< frame::XController >& xChartController )
  76 {
  77     m_xChartController = xChartController;
  78 }
  79
  80 void SelectorListBox::UpdateChartElementsListAndSelection()
  81 {
  82     Clear();
  83     m_aEntries.clear();
  84
  85     Reference< frame::XController > xChartController( m_xChartController );
  86     if( xChartController.is() )
  87     {
  88         Reference< view::XSelectionSupplier > xSelectionSupplier( xChartController, uno::UNO_QUERY);
  89         ObjectIdentifier aSelectedOID;
  90         OUString aSelectedCID;
  91         if( xSelectionSupplier.is() )
  92         {
  93             aSelectedOID = ObjectIdentifier( xSelectionSupplier->getSelection() );
  94             aSelectedCID = aSelectedOID.getObjectCID();
  95         }
  96
  97         Reference< chart2::XChartDocument > xChartDoc( xChartController->getModel(), uno::UNO_QUERY );
  98         ObjectType eType( aSelectedOID.getObjectType() );
  99         bool bAddSelectionToList = false;
 100         if ( eType == OBJECTTYPE_DATA_POINT || eType == OBJECTTYPE_DATA_LABEL || eType == OBJECTTYPE_SHAPE )
 101             bAddSelectionToList = true;
 102
 103         Reference< uno::XInterface > xChartView;
 104         Reference< lang::XMultiServiceFactory > xFact( xChartController->getModel(), uno::UNO_QUERY );
 105         if( xFact.is() )
 106             xChartView = xFact->createInstance( CHART_VIEW_SERVICE_NAME );
 107         ExplicitValueProvider* pExplicitValueProvider = nullptr; //ExplicitValueProvider::getExplicitValueProvider(xChartView); this creates all visible data points, that's too much
 108         ObjectHierarchy aHierarchy( xChartDoc, pExplicitValueProvider, true /*bFlattenDiagram*/, true /*bOrderingForElementSelector*/ );
 109         lcl_addObjectsToList( aHierarchy, ::chart::ObjectHierarchy::getRootNodeOID(), m_aEntries, 0, xChartDoc );
 110
 111         std::vector< ListBoxEntryData >::iterator aIt( m_aEntries.begin() );
 112         if( bAddSelectionToList )
 113         {
 114             if ( aSelectedOID.isAutoGeneratedObject() )
 115             {
 116                 OUString aSeriesCID = ObjectIdentifier::createClassifiedIdentifierForParticle( ObjectIdentifier::getSeriesParticleFromCID( aSelectedCID ) );
 117                 for( aIt = m_aEntries.begin(); aIt != m_aEntries.end(); ++aIt )
 118                 {
 119                     if( aIt->OID.getObjectCID().match( aSeriesCID ) )
 120                     {
 121                         ListBoxEntryData aEntry;
 122                         aEntry.UIName = ObjectNameProvider::getNameForCID( aSelectedCID, xChartDoc );
 123                         aEntry.OID = aSelectedOID;
 124                         ++aIt;
 125                         if( aIt != m_aEntries.end() )
 126                             m_aEntries.insert(aIt, aEntry);
 127                         else
 128                             m_aEntries.push_back( aEntry );
 129                         break;
 130                     }
 131                 }
 132             }
 133             else if ( aSelectedOID.isAdditionalShape() )
 134             {
 135                 ListBoxEntryData aEntry;
 136                 SdrObject* pSelectedObj = DrawViewWrapper::getSdrObject( aSelectedOID.getAdditionalShape() );
 137                 OUString aName = pSelectedObj ? pSelectedObj->GetName() : OUString();
 138                 aEntry.UIName = ( aName.isEmpty() ?  SchResId( STR_OBJECT_SHAPE ) : aName );
 139                 aEntry.OID = aSelectedOID;
 140                 m_aEntries.push_back( aEntry );
 141             }
 142         }
 143
 144         sal_uInt16 nEntryPosToSelect = 0; bool bSelectionFound = false;
 145         sal_uInt16 nN=0;
 146         for (auto const& entry : m_aEntries)
 147         {
 148             InsertEntry(entry.UIName);
 149             if ( !bSelectionFound && aSelectedOID == entry.OID )
 150             {
 151                 nEntryPosToSelect = nN;
 152                 bSelectionFound = true;
 153             }
 154             ++nN;
 155         }
 156
 157         if( bSelectionFound )
 158             SelectEntryPos(nEntryPosToSelect);
 159
 160         sal_Int32 nEntryCount = GetEntryCount();
 161         if( nEntryCount > 100 )
 162             nEntryCount = 100;
 163         SetDropDownLineCount( nEntryCount );
 164     }
 165     SaveValue(); //remind current selection pos
 166 }
 167
 168 void SelectorListBox::ReleaseFocus_Impl()
 169 {
 170     if ( !m_bReleaseFocus )
 171     {
 172         m_bReleaseFocus = true;
 173         return;
 174     }
 175
 176     Reference< frame::XController > xController( m_xChartController );
 177     Reference< frame::XFrame > xFrame( xController->getFrame() );
 178     if ( xFrame.is() && xFrame->getContainerWindow().is() )
 179         xFrame->getContainerWindow()->setFocus();
 180 }
 181
 182 void SelectorListBox::Select()
 183 {
 184     ListBox::Select();
 185
 186     if ( !IsTravelSelect() )
 187     {
 188         const sal_Int32 nPos = GetSelectedEntryPos();
 189         if( static_cast<size_t>(nPos) < m_aEntries.size() )
 190         {
 191             ObjectIdentifier aOID = m_aEntries[nPos].OID;
 192             Reference< view::XSelectionSupplier > xSelectionSupplier( m_xChartController.get(), uno::UNO_QUERY );
 193             if( xSelectionSupplier.is() )
 194                 xSelectionSupplier->select( aOID.getAny() );
 195         }
 196         ReleaseFocus_Impl();
 197     }
 198 }
 199
 200 bool SelectorListBox::EventNotify( NotifyEvent& rNEvt )
 201 {
 202     bool bHandled = false;
 203
 204     if ( rNEvt.GetType() == MouseNotifyEvent::KEYINPUT )
 205     {
 206         sal_uInt16 nCode = rNEvt.GetKeyEvent()->GetKeyCode().GetCode();
 207
 208         switch ( nCode )
 209         {
 210             case KEY_RETURN:
 211             case KEY_TAB:
 212             {
 213                 if ( nCode == KEY_TAB )
 214                     m_bReleaseFocus = false;
 215                 else
 216                     bHandled = true;
 217                 Select();
 218                 break;
 219             }
 220
 221             case KEY_ESCAPE:
 222                 SelectEntryPos( GetSavedValue() ); //restore saved selection
 223                 ReleaseFocus_Impl();
 224                 break;
 225         }
 226     }
 227     else if ( rNEvt.GetType() == MouseNotifyEvent::LOSEFOCUS )
 228     {
 229         if ( !HasFocus() )
 230             SelectEntryPos( GetSavedValue() );
 231     }
 232
 233     return bHandled || ListBox::EventNotify(rNEvt);
 234 }
 235
 236 Reference< css::accessibility::XAccessible > SelectorListBox::CreateAccessible()
 237 {
 238     UpdateChartElementsListAndSelection();
 239     return ListBox::CreateAccessible();
 240 }
 241
 242 OUString SAL_CALL ElementSelectorToolbarController::getImplementationName()
 243 {
 244     return OUString(lcl_aServiceName);
 245 }
 246
 247 sal_Bool SAL_CALL ElementSelectorToolbarController::supportsService( const OUString& rServiceName )
 248 {
 249     return cppu::supportsService(this, rServiceName);
 250 }
 251
 252 css::uno::Sequence< OUString > SAL_CALL ElementSelectorToolbarController::getSupportedServiceNames()
 253 {
 254     return { "com.sun.star.frame.ToolbarController" };
 255 }
 256 ElementSelectorToolbarController::ElementSelectorToolbarController()
 257 {
 258 }
 259 ElementSelectorToolbarController::~ElementSelectorToolbarController()
 260 {
 261 }
 262 // XInterface
 263 Any SAL_CALL ElementSelectorToolbarController::queryInterface( const Type& _rType )
 264 {
 265     Any aReturn = ToolboxController::queryInterface(_rType);
 266     if (!aReturn.hasValue())
 267         aReturn = ElementSelectorToolbarController_BASE::queryInterface(_rType);
 268     return aReturn;
 269 }
 270 void SAL_CALL ElementSelectorToolbarController::acquire() throw ()
 271 {
 272     ToolboxController::acquire();
 273 }
 274 void SAL_CALL ElementSelectorToolbarController::release() throw ()
 275 {
 276     ToolboxController::release();
 277 }
 278 void SAL_CALL ElementSelectorToolbarController::statusChanged( const frame::FeatureStateEvent& rEvent )
 279 {
 280     if( m_apSelectorListBox.get() )
 281     {
 282         SolarMutexGuard aSolarMutexGuard;
 283         if ( rEvent.FeatureURL.Path == "ChartElementSelector" )
 284         {
 285             Reference< frame::XController > xChartController;
 286             rEvent.State >>= xChartController;
 287             m_apSelectorListBox->SetChartController( xChartController );
 288             m_apSelectorListBox->UpdateChartElementsListAndSelection();
 289         }
 290     }
 291 }
 292 uno::Reference< awt::XWindow > SAL_CALL ElementSelectorToolbarController::createItemWindow( const uno::Reference< awt::XWindow >& xParent )
 293 {
 294     uno::Reference< awt::XWindow > xItemWindow;
 295     if( !m_apSelectorListBox.get() )
 296     {
 297         VclPtr<vcl::Window> pParent = VCLUnoHelper::GetWindow( xParent );
 298         if( pParent )
 299         {
 300             m_apSelectorListBox.reset( VclPtr<SelectorListBox>::Create( pParent, WB_DROPDOWN|WB_AUTOHSCROLL|WB_BORDER ) );
 301             ::Size aLogicalSize( 75, 160 );
 302             ::Size aPixelSize = m_apSelectorListBox->LogicToPixel(aLogicalSize, MapMode(MapUnit::MapAppFont));
 303             m_apSelectorListBox->SetSizePixel( aPixelSize );
 304             m_apSelectorListBox->SetDropDownLineCount( 5 );
 305         }
 306     }
 307     if( m_apSelectorListBox.get() )
 308         xItemWindow = VCLUnoHelper::GetInterface( m_apSelectorListBox.get() );
 309     return xItemWindow;
 310 }
 311
 312 } // chart2
 313
 314 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 315 com_sun_star_comp_chart_ElementSelectorToolbarController_get_implementation(css::uno::XComponentContext *,
 316                                                                             css::uno::Sequence<css::uno::Any> const &)
 317 {
 318     return cppu::acquire(new chart::ElementSelectorToolbarController );
 319 }
 320
 321 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */