extensions/source/propctrlr/buttonnavigationhandler.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_EXTENSIONS_SOURCE_PROPCTRLR_BUTTONNAVIGATIONHANDLER_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_BUTTONNAVIGATIONHANDLER_HXX
  22
  23 #include "propertyhandler.hxx"
  24
  25
  26 namespace pcr
  27 {
  28
  29     class ButtonNavigationHandler;
  30     typedef HandlerComponentBase< ButtonNavigationHandler > ButtonNavigationHandler_Base;
  31     /** a property handler for any virtual string properties
  32     */
  33     class ButtonNavigationHandler : public ButtonNavigationHandler_Base
  34     {
  35     private:
  36         css::uno::Reference< css::inspection::XPropertyHandler >
  37             m_xSlaveHandler;
  38
  39     public:
  40         explicit ButtonNavigationHandler(
  41             const css::uno::Reference< css::uno::XComponentContext >& _rxContext
  42         );
  43         /// @throws css::uno::RuntimeException
  44         static OUString getImplementationName_static(  );
  45         /// @throws css::uno::RuntimeException
  46         static css::uno::Sequence< OUString > getSupportedServiceNames_static(  );
  47
  48     protected:
  49         virtual ~ButtonNavigationHandler() override;
  50
  51         static bool    isNavigationCapableButton( const css::uno::Reference< css::beans::XPropertySet >& _rxComponent );
  52
  53     protected:
  54         // XPropertyHandler overriables
  55         virtual void                                    SAL_CALL inspect( const css::uno::Reference< css::uno::XInterface >& _rxIntrospectee ) override;
  56         virtual css::uno::Any                           SAL_CALL getPropertyValue( const OUString& _rPropertyName ) override;
  57         virtual void                                    SAL_CALL setPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rValue ) override;
  58         virtual css::beans::PropertyState               SAL_CALL getPropertyState( const OUString& _rPropertyName ) override;
  59         virtual css::uno::Sequence< OUString >          SAL_CALL getActuatingProperties( ) override;
  60         virtual css::inspection::InteractiveSelectionResult
  61                                                         SAL_CALL onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, css::uno::Any& _rData, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI ) override;
  62         virtual void                                    SAL_CALL actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const css::uno::Any& _rNewValue, const css::uno::Any& _rOldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI, sal_Bool _bFirstTimeInit ) override;
  63         virtual css::inspection::LineDescriptor         SAL_CALL describePropertyLine( const OUString& _rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory ) override;
  64
  65         // PropertyHandler overridables
  66         virtual css::uno::Sequence< css::beans::Property >
  67                                                         doDescribeSupportedProperties() const override;
  68     };
  69
  70
  71 } // namespace pcr
  72
  73
  74 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_BUTTONNAVIGATIONHANDLER_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */