handlerhelper.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#pragma once
 
#include <com/sun/star/beans/Property.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/script/XTypeConverter.hpp>
#include <com/sun/star/inspection/XPropertyControlFactory.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/beans/Optional.hpp>
#include <unotools/resmgr.hxx>
 
#include <memory>
#include <vector>
 
namespace weld { class Builder; class Widget; class Window; }
namespace com::sun::star {
    namespace inspection {
        struct LineDescriptor;
    }
}
 
namespace pcr
{
 
 
    //= PropertyHandlerHelper
 
    class PropertyHandlerHelper
    {
    public:
        static  void describePropertyLine(
                const css::beans::Property& _rProperty,
                css::inspection::LineDescriptor& /* [out] */ _out_rDescriptor,
                const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory
            );
 
        static css::uno::Any convertToPropertyValue(
                const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
                const css::uno::Reference< css::script::XTypeConverter >& _rxTypeConverter,
                const css::beans::Property& _rProperty,
                const css::uno::Any& _rControlValue
            );
 
        static css::uno::Any convertToControlValue(
                const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
                const css::uno::Reference< css::script::XTypeConverter >& _rxTypeConverter,
                const css::uno::Any& _rPropertyValue,
                const css::uno::Type& _rControlValueType
            );
 
        static css::uno::Reference< css::inspection::XPropertyControl >
            createListBoxControl(
                const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory,
                std::vector< OUString >&& _rInitialListEntries,
                bool _bReadOnlyControl,
                bool _bSorted
            );
 
        static css::uno::Reference< css::inspection::XPropertyControl >
            createListBoxControl(
                const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory,
                const TranslateId* pTransIds, size_t nElements,
                bool _bReadOnlyControl
            );
 
        static css::uno::Reference< css::inspection::XPropertyControl >
            createComboBoxControl(
                const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory,
                std::vector< OUString >&& _rInitialListEntries,
                bool _bSorted
            );
 
        static css::uno::Reference< css::inspection::XPropertyControl >
            createNumericControl(
                const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory,
                sal_Int16 _nDigits,
                const css::beans::Optional< double >& _rMinValue,
                const css::beans::Optional< double >& _rMaxValue
            );
 
        static void setContextDocumentModified(
                const css::uno::Reference< css::uno::XComponentContext > & _rContext
            );
 
        static css::uno::Reference< css::uno::XInterface > getContextDocument( const css::uno::Reference<css::uno::XComponentContext> & _rContext );
 
        static css::uno::Reference< css::uno::XInterface > getContextDocument_throw( const css::uno::Reference<css::uno::XComponentContext> & _rContext );
 
        static weld::Window* getDialogParentFrame( const css::uno::Reference< css::uno::XComponentContext > & _rContext );
 
 
        static bool requiresReadOnlyControl( sal_Int16 _nPropertyAttributes )
        {
            return ( _nPropertyAttributes & css::beans::PropertyAttribute::READONLY ) != 0;
        }
 
        static std::unique_ptr<weld::Builder> makeBuilder(const OUString& rUIFile, const css::uno::Reference<css::uno::XComponentContext>& rContext);
 
        static void setBuilderParent(const css::uno::Reference<css::uno::XComponentContext>& rContext, weld::Widget* pParent);
 
        static void clearBuilderParent(const css::uno::Reference<css::uno::XComponentContext>& rContext);
 
    private:
        PropertyHandlerHelper( const PropertyHandlerHelper& ) = delete;
        PropertyHandlerHelper& operator=( const PropertyHandlerHelper& ) = delete;
    };
 
 
} // namespace pcr
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */