svx/source/inc/fmshimp.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 #ifndef INCLUDED_SVX_SOURCE_INC_FMSHIMP_HXX
  20 #define INCLUDED_SVX_SOURCE_INC_FMSHIMP_HXX
  21
  22 #include <config_options.h>
  23 #include <com/sun/star/sdbc/XResultSet.hpp>
  24 #include <com/sun/star/container/ContainerEvent.hpp>
  25 #include <com/sun/star/container/XContainerListener.hpp>
  26 #include <com/sun/star/awt/XControl.hpp>
  27 #include <com/sun/star/awt/XControlContainer.hpp>
  28 #include <com/sun/star/form/XForm.hpp>
  29 #include <com/sun/star/form/runtime/XFormController.hpp>
  30 #include <com/sun/star/form/XFormComponent.hpp>
  31 #include <com/sun/star/form/NavigationBarMode.hpp>
  32 #include <com/sun/star/frame/XFrame.hpp>
  33 #include <com/sun/star/view/XSelectionChangeListener.hpp>
  34 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  35 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  36 #include <com/sun/star/form/runtime/FeatureState.hpp>
  37 #include <tools/diagnose_ex.h>
  38 #include <vcl/timer.hxx>
  39 #include <vcl/window.hxx>
  40 #include <sfx2/shell.hxx>
  41 #include <svx/svdmark.hxx>
  42 #include <svx/fmsearch.hxx>
  43
  44 #include <svx/fmtools.hxx>
  45 #include <osl/mutex.hxx>
  46 #include <comphelper/container.hxx>
  47 #include <cppuhelper/compbase.hxx>
  48 #include <unotools/configitem.hxx>
  49 #include "formcontrolling.hxx"
  50 #include "fmdocumentclassification.hxx"
  51 #include <o3tl/typed_flags_set.hxx>
  52
  53 #include <queue>
  54 #include <vector>
  55 #include <memory>
  56
  57 typedef std::vector< css::uno::Reference< css::form::XForm > > FmFormArray;
  58
  59 // catch database exceptions if they occur
  60 #define DO_SAFE(statement) try { statement; } catch( const Exception& ) { TOOLS_WARN_EXCEPTION("svx", "unhandled exception (I tried to move a cursor (or something like that).)"); }
  61
  62 enum class LoopGridsSync {
  63     DISABLE_SYNC     = 1,
  64     FORCE_SYNC       = 2,
  65     ENABLE_SYNC      = 3
  66 };
  67 enum class LoopGridsFlags
  68 {
  69     NONE             = 0,
  70     DISABLE_ROCTRLR  = 4
  71 };
  72 namespace o3tl
  73 {
  74     template<> struct typed_flags<LoopGridsFlags> : is_typed_flags<LoopGridsFlags, 0x04> {};
  75 }
  76
  77
  78 // flags for controlling the behaviour when calling loadForms
  79 enum class LoadFormsFlags {
  80     Load          = 0x0000,      // default: simply load
  81     Sync          = 0x0000,      // default: do in synchronous
  82     Unload        = 0x0001,      // unload
  83     Async         = 0x0002      // do this async
  84 };
  85 namespace o3tl {
  86     template<> struct typed_flags<LoadFormsFlags> : is_typed_flags<LoadFormsFlags, 0x0003> {};
  87 }
  88
  89 namespace weld {
  90     class Menu;
  91 }
  92
  93 // a class iterating through all fields of a form which are bound to a field
  94 // sub forms are ignored, grid columns (where the grid is a direct child of the form) are included
  95 class FmXBoundFormFieldIterator : public ::comphelper::IndexAccessIterator
  96 {
  97 public:
  98     FmXBoundFormFieldIterator(const css::uno::Reference< css::uno::XInterface>& _rStartingPoint) : ::comphelper::IndexAccessIterator(_rStartingPoint) { }
  99
 100 protected:
 101     virtual bool ShouldHandleElement(const css::uno::Reference< css::uno::XInterface>& _rElement) override;
 102     virtual bool ShouldStepInto(const css::uno::Reference< css::uno::XInterface>& _rContainer) const override;
 103 };
 104
 105 class FmFormPage;
 106 class FmFormPageImpl;
 107
 108 struct FmLoadAction
 109 {
 110     FmFormPage* pPage;
 111     ImplSVEvent * nEventId;
 112     LoadFormsFlags  nFlags;
 113
 114     FmLoadAction( FmFormPage* _pPage, LoadFormsFlags _nFlags, ImplSVEvent * _nEventId )
 115         :pPage( _pPage ), nEventId( _nEventId ), nFlags( _nFlags )
 116     {
 117     }
 118 };
 119
 120
 121 class SfxViewFrame;
 122 typedef ::cppu::WeakComponentImplHelper<   css::beans::XPropertyChangeListener
 123                                         ,   css::container::XContainerListener
 124                                         ,   css::view::XSelectionChangeListener
 125                                         ,   css::form::XFormControllerListener
 126                                         >   FmXFormShell_BD_BASE;
 127
 128
 129 class FmXFormShell_Base_Disambiguation : public FmXFormShell_BD_BASE
 130 {
 131     using css::beans::XPropertyChangeListener::disposing;
 132 protected:
 133     FmXFormShell_Base_Disambiguation( ::osl::Mutex& _rMutex );
 134     using WeakComponentImplHelperBase::disposing;
 135 };
 136
 137
 138 namespace svx
 139 {
 140     class FmTextControlShell;
 141 }
 142
 143
 144 typedef FmXFormShell_Base_Disambiguation    FmXFormShell_BASE;
 145 typedef ::utl::ConfigItem                   FmXFormShell_CFGBASE;
 146
 147 struct SdrViewEvent;
 148 class FmFormShell;
 149 class FmFormView;
 150 class FmFormObj;
 151 class UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) FmXFormShell final : public FmXFormShell_BASE
 152                                     ,public FmXFormShell_CFGBASE
 153                                     ,public svx::IControllerFeatureInvalidation
 154 {
 155     friend class FmFormView;
 156     friend class FmXFormView;
 157
 158     class SuspendPropertyTracking;
 159     friend class SuspendPropertyTracking;
 160
 161     // timer for delayed mark
 162     Timer               m_aMarkTimer;
 163     std::vector<SdrObject*> m_arrSearchedControls;
 164         // We enable a permanent cursor for the grid we found a searched text, it's disabled in the next "found" event.
 165     FmFormArray         m_aSearchForms;
 166
 167     struct SAL_DLLPRIVATE InvalidSlotInfo {
 168         sal_uInt16 id;
 169         sal_uInt8   flags;
 170         InvalidSlotInfo(sal_uInt16 slotId, sal_uInt8 flgs) : id(slotId), flags(flgs) {};
 171     };
 172     std::vector<InvalidSlotInfo> m_arrInvalidSlots;
 173         // we explicitly switch off the propbrw before leaving the design mode
 174         // this flag tells us if we have to switch it on again when reentering
 175
 176     css::form::NavigationBarMode   m_eNavigate;                // kind of navigation
 177
 178         // since I want to mark an SdrObject when searching for the treatment of the "found",
 179         // I get all relevant objects before yanking up of the search dialog
 180         // (the array is thus only valid during the search process)
 181     std::vector<tools::Long> m_arrRelativeGridColumn;
 182
 183     ::osl::Mutex    m_aMutex;
 184     ImplSVEvent *   m_nInvalidationEvent;
 185     ImplSVEvent *   m_nActivationEvent;
 186     ::std::queue< FmLoadAction >
 187                     m_aLoadingPages;
 188
 189     FmFormShell*                m_pShell;
 190     std::unique_ptr<svx::FmTextControlShell>  m_pTextShell;
 191
 192     svx::ControllerFeatures   m_aActiveControllerFeatures;
 193     svx::ControllerFeatures   m_aNavControllerFeatures;
 194
 195     // current form, controller
 196     // only available in the alive mode
 197     css::uno::Reference< css::form::runtime::XFormController >    m_xActiveController;
 198     css::uno::Reference< css::form::runtime::XFormController >    m_xNavigationController;
 199     css::uno::Reference< css::form::XForm >                       m_xActiveForm;
 200
 201     // current container of a page
 202     // only available in the design mode
 203     css::uno::Reference< css::container::XIndexAccess>            m_xForms;
 204
 205     // the currently selected objects, as to be displayed in the property browser
 206     InterfaceBag                                                  m_aCurrentSelection;
 207     /// the currently selected form, or the form which all currently selected controls belong to, or <NULL/>
 208     css::uno::Reference< css::form::XForm >                       m_xCurrentForm;
 209     /// the last selection/marking of controls only. Necessary to implement the "Control properties" slot
 210     InterfaceBag                                                  m_aLastKnownMarkedControls;
 211
 212
 213         // And this is also for the 'found': When I find in GridControls, I need the column,
 214         // but only get the number of the field corresponding to the number of the
 215         // column + <offset>, where the offset depends on the position of the GridControl
 216         // in the form. So here is a conversion.
 217     css::uno::Reference< css::awt::XControlModel>                 m_xLastGridFound;
 218      // the frame we live in
 219     css::uno::Reference< css::frame::XFrame>                      m_xAttachedFrame;
 220     // Administration of external form views (see the SID_FM_VIEW_AS_GRID-slot)
 221     css::uno::Reference< css::frame::XController >                m_xExternalViewController;      // the controller for the external form view
 222     css::uno::Reference< css::form::runtime::XFormController >    m_xExtViewTriggerController;    // the nav controller at the time the external display was triggered
 223     css::uno::Reference< css::sdbc::XResultSet >                  m_xExternalDisplayedForm;       // the form which the external view is based on
 224
 225     mutable ::svxform::DocumentType
 226                     m_eDocumentType;        /// the type of document we're living in
 227     sal_Int16       m_nLockSlotInvalidation;
 228     bool        m_bHadPropertyBrowserInDesignMode : 1;
 229
 230     bool        m_bTrackProperties  : 1;
 231         // should I (or the owner of this impl class) take car of the update of the css::beans::Property-Browser?
 232
 233     bool        m_bUseWizards : 1;
 234
 235     bool        m_bDatabaseBar      : 1;    // is there a database bar
 236     bool        m_bInActivate       : 1;    // is a controller activated
 237     bool        m_bSetFocus         : 1;    // may the focus be changed over
 238     bool        m_bFilterMode       : 1;    // is a filter currently set to the controls
 239     bool        m_bChangingDesignMode:1;    // sal_True within SetDesignMode
 240     bool        m_bPreparedClose    : 1;    // for the current modification state of the current form
 241                                                 //  PrepareClose had been called and the user denied to save changes
 242     bool        m_bFirstActivation  : 1;    // has the shell ever been activated?
 243
 244 public:
 245     // attribute access
 246     SAL_DLLPRIVATE const css::uno::Reference< css::frame::XFrame >&
 247                 getHostFrame_Lock() const { return m_xAttachedFrame; }
 248     SAL_DLLPRIVATE const css::uno::Reference< css::sdbc::XResultSet >&
 249                 getExternallyDisplayedForm_Lock() const { return m_xExternalDisplayedForm; }
 250
 251     SAL_DLLPRIVATE bool
 252                 didPrepareClose_Lock() const { return m_bPreparedClose; }
 253     SAL_DLLPRIVATE void
 254                 didPrepareClose_Lock(bool bDid) { m_bPreparedClose = bDid; }
 255
 256     SAL_DLLPRIVATE FmXFormShell(FmFormShell& _rShell, SfxViewFrame* _pViewFrame);
 257
 258 private:
 259     SAL_DLLPRIVATE virtual ~FmXFormShell() override;
 260
 261 // EventListener
 262     SAL_DLLPRIVATE virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 263
 264 // css::container::XContainerListener
 265     SAL_DLLPRIVATE virtual void SAL_CALL elementInserted(const css::container::ContainerEvent& rEvent) override;
 266     SAL_DLLPRIVATE virtual void SAL_CALL elementReplaced(const css::container::ContainerEvent& rEvent) override;
 267     SAL_DLLPRIVATE virtual void SAL_CALL elementRemoved(const css::container::ContainerEvent& rEvent) override;
 268
 269 // XSelectionChangeListener
 270     SAL_DLLPRIVATE virtual void SAL_CALL selectionChanged(const css::lang::EventObject& rEvent) override;
 271
 272 // css::beans::XPropertyChangeListener
 273     SAL_DLLPRIVATE virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent& evt) override;
 274
 275 // css::form::XFormControllerListener
 276     SAL_DLLPRIVATE virtual void SAL_CALL formActivated(const css::lang::EventObject& rEvent) override;
 277     SAL_DLLPRIVATE virtual void SAL_CALL formDeactivated(const css::lang::EventObject& rEvent) override;
 278
 279 // OComponentHelper
 280     SAL_DLLPRIVATE virtual void SAL_CALL disposing() override;
 281
 282 public:
 283     SAL_DLLPRIVATE void EnableTrackProperties_Lock(bool bEnable) { m_bTrackProperties = bEnable; }
 284     SAL_DLLPRIVATE bool IsTrackPropertiesEnabled_Lock() const { return m_bTrackProperties; }
 285
 286     // activation handling
 287     SAL_DLLPRIVATE void        viewActivated_Lock(FmFormView& _rCurrentView, bool _bSyncAction = false);
 288     SAL_DLLPRIVATE void        viewDeactivated_Lock(FmFormView& _rCurrentView, bool _bDeactivateController = true);
 289
 290     // IControllerFeatureInvalidation
 291     SAL_DLLPRIVATE virtual void invalidateFeatures/*_NoLock*/( const ::std::vector< sal_Int32 >& _rFeatures ) override;
 292
 293     SAL_DLLPRIVATE void ExecuteTabOrderDialog_Lock( // execute SID_FM_TAB_DIALOG
 294         const css::uno::Reference< css::awt::XTabControllerModel >& _rxForForm
 295     );
 296
 297     // stuff
 298     SAL_DLLPRIVATE void AddElement_Lock(const css::uno::Reference< css::uno::XInterface>& Element);
 299     SAL_DLLPRIVATE void RemoveElement_Lock(const css::uno::Reference< css::uno::XInterface>& Element);
 300
 301     /** updates m_xForms, to be either <NULL/>, if we're in alive mode, or our current page's forms collection,
 302         if in design mode
 303     */
 304     SAL_DLLPRIVATE void UpdateForms_Lock(bool bInvalidate);
 305
 306     SAL_DLLPRIVATE void ExecuteSearch_Lock();      // execute SID_FM_SEARCH
 307     SAL_DLLPRIVATE void CreateExternalView_Lock(); // execute SID_FM_VIEW_AS_GRID
 308
 309     SAL_DLLPRIVATE bool GetY2KState_Lock(sal_uInt16 & n);
 310     SAL_DLLPRIVATE void SetY2KState_Lock(sal_uInt16 n);
 311
 312 private:
 313     // form handling
 314     /// load or unload the forms on a page
 315     SAL_DLLPRIVATE void loadForms_Lock( FmFormPage* _pPage, const LoadFormsFlags _nBehaviour );
 316     SAL_DLLPRIVATE void smartControlReset( const css::uno::Reference< css::container::XIndexAccess >& _rxModels );
 317
 318
 319     SAL_DLLPRIVATE void startListening_Lock();
 320     SAL_DLLPRIVATE void stopListening_Lock();
 321
 322     SAL_DLLPRIVATE css::uno::Reference< css::awt::XControl >
 323         impl_getControl_Lock(
 324             const css::uno::Reference< css::awt::XControlModel>& i_rxModel,
 325             const FmFormObj& i_rKnownFormObj
 326         );
 327
 328     // collects in strNames the names of all forms
 329     SAL_DLLPRIVATE static void impl_collectFormSearchContexts_nothrow_Lock(
 330         const css::uno::Reference< css::uno::XInterface>& _rxStartingPoint,
 331         const OUString& _rCurrentLevelPrefix,
 332         FmFormArray& _out_rForms,
 333         ::std::vector< OUString >& _out_rNames );
 334
 335     /** checks whenever the instance is already disposed, if so, this is reported as assertion error (debug
 336         builds only) and <TRUE/> is returned.
 337     */
 338     SAL_DLLPRIVATE bool    impl_checkDisposed_Lock() const;
 339
 340 public:
 341     // method for non design mode (alive mode)
 342     SAL_DLLPRIVATE void setActiveController_Lock(const css::uno::Reference< css::form::runtime::XFormController>& _xController, bool _bNoSaveOldContent = false);
 343     SAL_DLLPRIVATE const css::uno::Reference< css::form::runtime::XFormController>& getActiveController_Lock() const { return m_xActiveController; }
 344     SAL_DLLPRIVATE const css::uno::Reference< css::form::runtime::XFormController>& getActiveInternalController_Lock() const { return m_xActiveController == m_xExternalViewController ? m_xExtViewTriggerController : m_xActiveController; }
 345     SAL_DLLPRIVATE const css::uno::Reference< css::form::XForm>& getActiveForm_Lock() const { return m_xActiveForm; }
 346     SAL_DLLPRIVATE const css::uno::Reference< css::form::runtime::XFormController>& getNavController_Lock() const { return m_xNavigationController; }
 347
 348     SAL_DLLPRIVATE const svx::ControllerFeatures& getActiveControllerFeatures_Lock() const
 349         { return m_aActiveControllerFeatures; }
 350     SAL_DLLPRIVATE const svx::ControllerFeatures& getNavControllerFeatures_Lock() const
 351         { return m_aNavControllerFeatures.isAssigned() ? m_aNavControllerFeatures : m_aActiveControllerFeatures; }
 352
 353     /** announces a new "current selection"
 354         @return
 355             <TRUE/> if and only if the to-bet-set selection was different from the previous selection
 356     */
 357     SAL_DLLPRIVATE bool setCurrentSelection_Lock(const InterfaceBag& rSelection);
 358
 359     /** sets the new selection to the last known marked controls
 360     */
 361     SAL_DLLPRIVATE bool selectLastMarkedControls_Lock();
 362
 363     /** retrieves the current selection
 364     */
 365     void    getCurrentSelection_Lock(InterfaceBag& /* [out] */ _rSelection) const;
 366
 367     /** sets a new current selection as indicated by a mark list
 368         @return
 369             <TRUE/> if and only if the to-bet-set selection was different from the previous selection
 370     */
 371     SAL_DLLPRIVATE bool setCurrentSelectionFromMark_Lock(const SdrMarkList& rMarkList);
 372
 373     /// returns the currently selected form, or the form which all currently selected controls belong to, or <NULL/>
 374     SAL_DLLPRIVATE const css::uno::Reference< css::form::XForm >&
 375                 getCurrentForm_Lock() const { return m_xCurrentForm; }
 376     SAL_DLLPRIVATE void forgetCurrentForm_Lock();
 377     /// returns whether the last known marking contained only controls
 378     SAL_DLLPRIVATE bool onlyControlsAreMarked_Lock() const { return !m_aLastKnownMarkedControls.empty(); }
 379
 380     /// determines whether the current selection consists of exactly the given object
 381     SAL_DLLPRIVATE bool isSolelySelected_Lock(
 382                 const css::uno::Reference< css::uno::XInterface >& _rxObject
 383             );
 384
 385     /// handles a MouseButtonDown event of the FmFormView
 386     SAL_DLLPRIVATE void handleMouseButtonDown_Lock( const SdrViewEvent& _rViewEvent );
 387     /// handles the request for showing the "Properties"
 388     SAL_DLLPRIVATE void handleShowPropertiesRequest_Lock();
 389
 390     SAL_DLLPRIVATE bool hasForms_Lock() const { return m_xForms.is() && m_xForms->getCount() != 0; }
 391     SAL_DLLPRIVATE bool hasDatabaseBar_Lock() const { return m_bDatabaseBar; }
 392
 393     SAL_DLLPRIVATE void ShowSelectionProperties_Lock(bool bShow);
 394     SAL_DLLPRIVATE bool IsPropBrwOpen_Lock() const;
 395
 396     SAL_DLLPRIVATE void DetermineSelection_Lock(const SdrMarkList& rMarkList);
 397     SAL_DLLPRIVATE void SetSelection_Lock(const SdrMarkList& rMarkList);
 398     SAL_DLLPRIVATE void SetSelectionDelayed_Lock();
 399
 400     SAL_DLLPRIVATE void SetDesignMode_Lock(bool bDesign);
 401
 402     SAL_DLLPRIVATE bool GetWizardUsing_Lock() const { return m_bUseWizards; }
 403     SAL_DLLPRIVATE void SetWizardUsing_Lock(bool _bUseThem);
 404
 405         // setting the filter mode
 406     SAL_DLLPRIVATE bool isInFilterMode_Lock() const { return m_bFilterMode; }
 407     SAL_DLLPRIVATE void startFiltering_Lock();
 408     SAL_DLLPRIVATE void stopFiltering_Lock(bool bSave);
 409
 410         // fills rMenu to be a menu that contains all ControlConversion entries
 411     SAL_DLLPRIVATE static void GetConversionMenu_Lock(weld::Menu& rMenu);
 412
 413     /// checks whether a given control conversion slot can be applied to the current selection
 414     SAL_DLLPRIVATE bool canConvertCurrentSelectionToControl_Lock(const OString& rIdent);
 415     /// enables or disables all conversion slots in a menu, according to the current selection
 416     SAL_DLLPRIVATE void checkControlConversionSlotsForCurrentSelection_Lock(weld::Menu& rMenu);
 417     /// executes a control conversion slot for a given object
 418     SAL_DLLPRIVATE bool executeControlConversionSlot_Lock(const css::uno::Reference< css::form::XFormComponent >& _rxObject, const OString& rIdent);
 419     /** executes a control conversion slot for the current selection
 420         @precond canConvertCurrentSelectionToControl( <arg>_nSlotId</arg> ) must return <TRUE/>
 421     */
 422     SAL_DLLPRIVATE void executeControlConversionSlot_Lock(const OString& rIdent);
 423     /// checks whether the given slot id denotes a control conversion slot
 424     SAL_DLLPRIVATE static bool isControlConversionSlot(const OString& rIdent);
 425
 426     SAL_DLLPRIVATE void ExecuteTextAttribute_Lock(SfxRequest& _rReq);
 427     SAL_DLLPRIVATE void GetTextAttributeState_Lock(SfxItemSet& _rSet);
 428     SAL_DLLPRIVATE bool IsActiveControl_Lock(bool _bCountRichTextOnly) const;
 429     SAL_DLLPRIVATE void ForgetActiveControl_Lock();
 430     SAL_DLLPRIVATE void SetControlActivationHandler_Lock(const Link<LinkParamNone*,void>& _rHdl);
 431
 432     /// classifies our host document
 433     SAL_DLLPRIVATE ::svxform::DocumentType getDocumentType_Lock() const;
 434     SAL_DLLPRIVATE bool isEnhancedForm_Lock() const;
 435
 436     /// determines whether our host document is currently read-only
 437     SAL_DLLPRIVATE bool IsReadonlyDoc_Lock() const;
 438
 439     // Setting the curObject/selObject/curForm is delayed (SetSelectionDelayed). With the
 440     // following functions this can be inquired/enforced.
 441     SAL_DLLPRIVATE inline bool IsSelectionUpdatePending_Lock() const;
 442     SAL_DLLPRIVATE void        ForceUpdateSelection_Lock();
 443
 444     SAL_DLLPRIVATE css::uno::Reference< css::frame::XModel>          getContextDocument_Lock() const;
 445     SAL_DLLPRIVATE css::uno::Reference< css::form::XForm>            getInternalForm_Lock(const css::uno::Reference< css::form::XForm>& _xForm) const;
 446     SAL_DLLPRIVATE css::uno::Reference< css::sdbc::XResultSet>       getInternalForm_Lock(const css::uno::Reference< css::sdbc::XResultSet>& _xForm) const;
 447         // if the form belongs to the controller (extern) displaying a grid, the according internal form will
 448         // be displayed, _xForm else
 449
 450     // check if the current control of the active controller has the focus
 451     SAL_DLLPRIVATE bool HasControlFocus_Lock() const;
 452
 453 private:
 454     DECL_DLLPRIVATE_LINK(OnFoundData_Lock, FmFoundRecordInformation&, void);
 455     DECL_DLLPRIVATE_LINK(OnCanceledNotFound_Lock, FmFoundRecordInformation&, void);
 456     DECL_DLLPRIVATE_LINK(OnSearchContextRequest_Lock, FmSearchContext&, sal_uInt32);
 457     DECL_DLLPRIVATE_LINK(OnTimeOut_Lock, Timer*, void);
 458     DECL_DLLPRIVATE_LINK(OnFirstTimeActivation_Lock, void*, void);
 459     DECL_DLLPRIVATE_LINK(OnFormsCreated_Lock, FmFormPageImpl&, void);
 460
 461     SAL_DLLPRIVATE void LoopGrids_Lock(LoopGridsSync nSync, LoopGridsFlags nWhat = LoopGridsFlags::NONE);
 462
 463     // invalidation of slots
 464     SAL_DLLPRIVATE void InvalidateSlot_Lock(sal_Int16 nId, bool bWithId);
 465     SAL_DLLPRIVATE void UpdateSlot_Lock(sal_Int16 nId);
 466     // locking the invalidation - if the internal locking counter goes to 0, all accumulated slots
 467     // are invalidated (asynchronously)
 468     SAL_DLLPRIVATE void LockSlotInvalidation_Lock(bool bLock);
 469
 470     DECL_DLLPRIVATE_LINK(OnInvalidateSlots_Lock, void*, void);
 471
 472     SAL_DLLPRIVATE void CloseExternalFormViewer_Lock();
 473         // closes the task-local beamer displaying a grid view for a form
 474
 475     // ConfigItem related stuff
 476     SAL_DLLPRIVATE virtual void Notify( const css::uno::Sequence< OUString >& _rPropertyNames) override;
 477     SAL_DLLPRIVATE void implAdjustConfigCache_Lock();
 478
 479     SAL_DLLPRIVATE css::uno::Reference< css::awt::XControlContainer >
 480             getControlContainerForView_Lock() const;
 481
 482     /** finds and sets a default for m_xCurrentForm, if it is currently NULL
 483     */
 484     SAL_DLLPRIVATE void impl_defaultCurrentForm_nothrow_Lock();
 485
 486     /** sets m_xCurrentForm to the provided form, and updates everything which
 487         depends on the current form
 488     */
 489     SAL_DLLPRIVATE void impl_updateCurrentForm_Lock( const css::uno::Reference< css::form::XForm >& _rxNewCurForm );
 490
 491     /** adds or removes ourself as XEventListener at m_xActiveController
 492     */
 493     SAL_DLLPRIVATE void impl_switchActiveControllerListening_Lock(const bool _bListen);
 494
 495     /** add an element
 496     */
 497     SAL_DLLPRIVATE void    impl_AddElement_nothrow(const css::uno::Reference< css::uno::XInterface>& Element);
 498
 499     /** remove an element
 500     */
 501     SAL_DLLPRIVATE void    impl_RemoveElement_nothrow_Lock(const css::uno::Reference< css::uno::XInterface>& Element);
 502
 503     SAL_DLLPRIVATE virtual void ImplCommit() override;
 504
 505     // asynchronous cursor actions/navigation slot handling
 506
 507 public:
 508     /** execute the given form slot
 509         <p>Warning. Only a small set of slots implemented currently.</p>
 510         @param _nSlot
 511             the slot to execute
 512     */
 513     SAL_DLLPRIVATE void ExecuteFormSlot_Lock(sal_Int32 _nSlot);
 514
 515     /** determines whether the current form slot is currently enabled
 516     */
 517     SAL_DLLPRIVATE bool    IsFormSlotEnabled( sal_Int32 _nSlot, css::form::runtime::FeatureState* _pCompleteState );
 518
 519     SAL_DLLPRIVATE static OString SlotToIdent(sal_uInt16 nSlot);
 520
 521 private:
 522     DECL_DLLPRIVATE_LINK( OnLoadForms_Lock, void*, void );
 523 };
 524
 525
 526 inline bool FmXFormShell::IsSelectionUpdatePending_Lock() const
 527 {
 528     return m_aMarkTimer.IsActive();
 529 }
 530
 531
 532 // = An iterator that, emanating from an interface, looks for an object whose
 533 // = css::beans::Property-Set has a ControlSource and a BoundField property, the
 534 // = latter having a non-NULL value. If the interface itself does not meet this
 535 // = condition, it is tested whether it is a container (that is, has a
 536 // = css::container::XIndexAccess), then it is descended there and the same tried
 537 // = for each element of the container (again possibly with descent). If any
 538 // = object thereby has the required property, the part with the container test
 539 // = for that object is omitted.
 540 // =
 541
 542 class SearchableControlIterator : public ::comphelper::IndexAccessIterator
 543 {
 544     OUString         m_sCurrentValue;
 545         // the current value of the ControlSource css::beans::Property
 546
 547 public:
 548     const OUString& getCurrentValue() const { return m_sCurrentValue; }
 549
 550 public:
 551     SearchableControlIterator(css::uno::Reference< css::uno::XInterface> const & xStartingPoint);
 552
 553     virtual bool ShouldHandleElement(const css::uno::Reference< css::uno::XInterface>& rElement) override;
 554     virtual bool ShouldStepInto(const css::uno::Reference< css::uno::XInterface>& xContainer) const override;
 555     virtual void Invalidate() override { IndexAccessIterator::Invalidate(); m_sCurrentValue.clear(); }
 556 };
 557
 558 #endif // INCLUDED_SVX_SOURCE_INC_FMSHIMP_HXX
 559
 560 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */