include/sfx2/sfxbasecontroller.hxx

   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 #ifndef INCLUDED_SFX2_SFXBASECONTROLLER_HXX
  21 #define INCLUDED_SFX2_SFXBASECONTROLLER_HXX
  22
  23 #include <sal/config.h>
  24 #include <sfx2/dllapi.h>
  25 #include <sal/types.h>
  26 #include <com/sun/star/frame/XDispatch.hpp>
  27 #include <com/sun/star/frame/XDispatchProvider.hpp>
  28 #include <com/sun/star/frame/DispatchDescriptor.hpp>
  29 #include <com/sun/star/frame/XDispatchInformationProvider.hpp>
  30 #include <com/sun/star/frame/XController2.hpp>
  31 #include <com/sun/star/frame/XControllerBorder.hpp>
  32 #include <com/sun/star/frame/XModel.hpp>
  33 #include <com/sun/star/frame/XFrame.hpp>
  34 #include <com/sun/star/frame/XTitle.hpp>
  35 #include <com/sun/star/frame/XTitleChangeBroadcaster.hpp>
  36 #include <com/sun/star/util/URL.hpp>
  37 #include <com/sun/star/lang/XTypeProvider.hpp>
  38 #include <cppuhelper/implbase9.hxx>
  39 #include <cppuhelper/basemutex.hxx>
  40 #include <osl/mutex.hxx>
  41 #include <com/sun/star/task/XStatusIndicatorSupplier.hpp>
  42 #include <com/sun/star/ui/XContextMenuInterception.hpp>
  43 #include <com/sun/star/ui/XContextMenuInterceptor.hpp>
  44 #include <com/sun/star/awt/XMouseClickHandler.hpp>
  45 #include <com/sun/star/awt/XKeyHandler.hpp>
  46 #include <com/sun/star/awt/XUserInputInterception.hpp>
  47 #include <tools/link.hxx>
  48 #include <vcl/button.hxx>
  49
  50 #include <sfx2/viewsh.hxx>
  51 #include <sfx2/sfxuno.hxx>
  52
  53 struct  IMPL_SfxBaseController_DataContainer    ;   // impl. struct to hold member of class SfxBaseController
  54
  55 class SfxViewFrame;
  56
  57 sal_Int16 MapGroupIDToCommandGroup( sal_Int16 nGroupID );
  58
  59 //________________________________________________________________________________________________________
  60 //  class declarations
  61 //________________________________________________________________________________________________________
  62
  63 typedef ::cppu::WeakImplHelper9 <   css::frame::XController2
  64                                 ,   css::frame::XControllerBorder
  65                                 ,   css::frame::XDispatchProvider
  66                                 ,   css::task::XStatusIndicatorSupplier
  67                                 ,   css::ui::XContextMenuInterception
  68                                 ,   css::awt::XUserInputInterception
  69                                 ,   css::frame::XDispatchInformationProvider
  70                                 ,   css::frame::XTitle
  71                                 ,   css::frame::XTitleChangeBroadcaster
  72                                 >   SfxBaseController_Base;
  73
  74 class SFX2_DLLPUBLIC SfxBaseController  :public SfxBaseController_Base
  75                                         ,public ::cppu::BaseMutex
  76 {
  77 //________________________________________________________________________________________________________
  78 //  public methods
  79 //________________________________________________________________________________________________________
  80
  81 public:
  82
  83     //____________________________________________________________________________________________________
  84     //  constructor/destructor
  85     //____________________________________________________________________________________________________
  86
  87     /**___________________________________________________________________________________________________
  88         @short      -
  89         @descr      -
  90
  91         @seealso    -
  92
  93         @param      -
  94
  95         @return     -
  96
  97         @onerror    -
  98     */
  99
 100     SfxBaseController( SfxViewShell* pView ) ;
 101
 102     /**___________________________________________________________________________________________________
 103         @short      -
 104         @descr      -
 105
 106         @seealso    -
 107
 108         @param      -
 109
 110         @return     -
 111
 112         @onerror    -
 113     */
 114
 115     ~SfxBaseController() ;
 116
 117     SAL_DLLPRIVATE void ReleaseShell_Impl();
 118     SAL_DLLPRIVATE void BorderWidthsChanged_Impl();
 119
 120     css::uno::Reference< css::task::XStatusIndicator > SAL_CALL getStatusIndicator(  ) throw (css::uno::RuntimeException);
 121
 122     //____________________________________________________________________________________________________
 123     //  XController2
 124     //____________________________________________________________________________________________________
 125     virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getComponentWindow() throw (css::uno::RuntimeException);
 126     virtual OUString SAL_CALL getViewControllerName() throw (css::uno::RuntimeException);
 127     virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCreationArguments() throw (css::uno::RuntimeException);
 128
 129     //____________________________________________________________________________________________________
 130     //  XController
 131     //____________________________________________________________________________________________________
 132
 133     /**___________________________________________________________________________________________________
 134         @short      -
 135         @descr      -
 136
 137         @seealso    -
 138
 139         @param      -
 140
 141         @return     -
 142
 143         @onerror    -
 144     */
 145
 146     virtual void SAL_CALL attachFrame( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException ) ;
 147
 148     /**___________________________________________________________________________________________________
 149         @short      -
 150         @descr      -
 151
 152         @seealso    -
 153
 154         @param      -
 155
 156         @return     -
 157
 158         @onerror    -
 159     */
 160
 161     virtual sal_Bool SAL_CALL attachModel( const css::uno::Reference< css::frame::XModel >& xModel ) throw( css::uno::RuntimeException ) ;
 162
 163     /**___________________________________________________________________________________________________
 164         @short      -
 165         @descr      -
 166
 167         @seealso    -
 168
 169         @param      -
 170
 171         @return     -
 172
 173         @onerror    -
 174     */
 175
 176     virtual sal_Bool SAL_CALL suspend( sal_Bool bSuspend ) throw( css::uno::RuntimeException ) ;
 177
 178     /**___________________________________________________________________________________________________
 179         @short      -
 180         @descr      -
 181
 182         @seealso    -
 183
 184         @param      -
 185
 186         @return     -
 187
 188         @onerror    -
 189     */
 190
 191     css::uno::Any SAL_CALL getViewData() throw( css::uno::RuntimeException ) ;
 192
 193     /**___________________________________________________________________________________________________
 194         @short      -
 195         @descr      -
 196
 197         @seealso    -
 198
 199         @param      -
 200
 201         @return     -
 202
 203         @onerror    -
 204     */
 205
 206     void SAL_CALL restoreViewData( const css::uno::Any& aValue ) throw( css::uno::RuntimeException ) ;
 207
 208     /**___________________________________________________________________________________________________
 209         @short      -
 210         @descr      -
 211
 212         @seealso    -
 213
 214         @param      -
 215
 216         @return     -
 217
 218         @onerror    -
 219     */
 220
 221     css::uno::Reference< css::frame::XFrame > SAL_CALL getFrame() throw( css::uno::RuntimeException ) ;
 222
 223     /**___________________________________________________________________________________________________
 224         @short      -
 225         @descr      -
 226
 227         @seealso    -
 228
 229         @param      -
 230
 231         @return     -
 232
 233         @onerror    -
 234     */
 235
 236     css::uno::Reference< css::frame::XModel > SAL_CALL getModel() throw( css::uno::RuntimeException ) ;
 237
 238     //____________________________________________________________________________________________________
 239     //  XDispatchProvider
 240     //____________________________________________________________________________________________________
 241
 242     /**___________________________________________________________________________________________________
 243         @short      -
 244         @descr      -
 245
 246         @seealso    -
 247
 248         @param      -
 249
 250         @return     -
 251
 252         @onerror    -
 253     */
 254
 255     virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch(  const   css::util::URL &    aURL            ,
 256                                                                                   const   OUString &   sTargetFrameName,
 257                                                                                   FrameSearchFlags            eSearchFlags    ) throw( css::uno::RuntimeException ) ;
 258
 259     /**___________________________________________________________________________________________________
 260         @short      -
 261         @descr      -
 262
 263         @seealso    -
 264
 265         @param      -
 266
 267         @return     -
 268
 269         @onerror    -
 270     */
 271
 272     virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& seqDescriptor ) throw( css::uno::RuntimeException ) ;
 273
 274     //____________________________________________________________________________________________________
 275     //  XControllerBorder
 276     //____________________________________________________________________________________________________
 277
 278     virtual css::frame::BorderWidths SAL_CALL getBorder() throw (css::uno::RuntimeException);
 279     virtual void SAL_CALL addBorderResizeListener( const css::uno::Reference< css::frame::XBorderResizeListener >& xListener ) throw (css::uno::RuntimeException);
 280     virtual void SAL_CALL removeBorderResizeListener( const css::uno::Reference< css::frame::XBorderResizeListener >& xListener ) throw (css::uno::RuntimeException);
 281     virtual css::awt::Rectangle SAL_CALL queryBorderedArea( const css::awt::Rectangle& aPreliminaryRectangle ) throw (css::uno::RuntimeException);
 282
 283     //____________________________________________________________________________________________________
 284     //  XComponent
 285     //____________________________________________________________________________________________________
 286
 287     /**___________________________________________________________________________________________________
 288         @short      -
 289         @descr      -
 290
 291         @seealso    -
 292
 293         @param      -
 294
 295         @return     -
 296
 297         @onerror    -
 298     */
 299
 300     virtual void SAL_CALL dispose() throw( css::uno::RuntimeException ) ;
 301
 302     /**___________________________________________________________________________________________________
 303         @short      -
 304         @descr      -
 305
 306         @seealso    -
 307
 308         @param      -
 309
 310         @return     -
 311
 312         @onerror    -
 313     */
 314
 315     virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) throw( css::uno::RuntimeException ) ;
 316
 317     /**___________________________________________________________________________________________________
 318         @short      -
 319         @descr      -
 320
 321         @seealso    -
 322
 323         @param      -
 324
 325         @return     -
 326
 327         @onerror    -
 328     */
 329
 330     virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) throw( css::uno::RuntimeException ) ;
 331     virtual void SAL_CALL registerContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& xInterceptor ) throw( css::uno::RuntimeException );
 332     virtual void SAL_CALL releaseContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& xInterceptor ) throw( css::uno::RuntimeException );
 333
 334     virtual void SAL_CALL addKeyHandler( const css::uno::Reference< css::awt::XKeyHandler >& xHandler ) throw (css::uno::RuntimeException);
 335     virtual void SAL_CALL removeKeyHandler( const css::uno::Reference< css::awt::XKeyHandler >& xHandler ) throw (css::uno::RuntimeException);
 336     virtual void SAL_CALL addMouseClickHandler( const css::uno::Reference< css::awt::XMouseClickHandler >& xHandler ) throw (css::uno::RuntimeException);
 337     virtual void SAL_CALL removeMouseClickHandler( const css::uno::Reference< css::awt::XMouseClickHandler >& xHandler ) throw (css::uno::RuntimeException);
 338
 339     //____________________________________________________________________________________________________
 340     //  XDispatchInformationProvider
 341     //____________________________________________________________________________________________________
 342     virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedCommandGroups() throw (css::uno::RuntimeException);
 343     virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) throw (css::uno::RuntimeException);
 344
 345     // css::frame::XTitle
 346     virtual OUString SAL_CALL getTitle(  ) throw (css::uno::RuntimeException);
 347     virtual void SAL_CALL setTitle( const OUString& sTitle ) throw (css::uno::RuntimeException);
 348
 349     // css::frame::XTitleChangeBroadcaster
 350     virtual void SAL_CALL addTitleChangeListener( const css::uno::Reference< css::frame::XTitleChangeListener >& xListener )     throw (css::uno::RuntimeException);
 351     virtual void SAL_CALL removeTitleChangeListener( const css::uno::Reference< css::frame::XTitleChangeListener >& xListener ) throw (css::uno::RuntimeException);
 352
 353     // FIXME: TL needs this in sw/source/ui/uno/unotxdoc.cxx now;
 354     // either the _Impl name should vanish or there should be an "official" API
 355     SfxViewShell* GetViewShell_Impl() const;
 356     SAL_DLLPRIVATE sal_Bool HandleEvent_Impl( NotifyEvent& rEvent );
 357     SAL_DLLPRIVATE sal_Bool HasKeyListeners_Impl();
 358     SAL_DLLPRIVATE sal_Bool HasMouseClickListeners_Impl();
 359     SAL_DLLPRIVATE void SetCreationArguments_Impl( const css::uno::Sequence< css::beans::PropertyValue >& i_rCreationArgs );
 360     SAL_DLLPRIVATE css::uno::Reference< css::frame::XTitle > impl_getTitleHelper ();
 361 private:
 362     enum ConnectSfxFrame
 363     {
 364         E_CONNECT,
 365         E_DISCONNECT,
 366         E_RECONNECT
 367     };
 368     SAL_DLLPRIVATE void ConnectSfxFrame_Impl( const ConnectSfxFrame i_eConnect );
 369     SAL_DLLPRIVATE SfxViewFrame& GetViewFrame_Impl() const;
 370     SAL_DLLPRIVATE void ShowInfoBars( );
 371
 372     DECL_LINK( CheckOutHandler, void * );
 373
 374 //________________________________________________________________________________________________________
 375 //  private variables
 376 //________________________________________________________________________________________________________
 377
 378 private:
 379
 380     IMPL_SfxBaseController_DataContainer*   m_pData ;
 381
 382 } ; // class SfxBaseController
 383
 384 #endif  // _SFX_SFXBASECONTROLLER_HXX
 385
 386 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */