jobdata.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/uno/XComponentContext.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
 
#include <rtl/ustring.hxx>
 
#include <string_view>
#include <utility>
#include <vector>
 
namespace framework{
 
class JobData final
{
    public:
 
        enum EMode
        {
            E_UNKNOWN_MODE,
            E_ALIAS,
            E_SERVICE,
            E_EVENT
        };
 
        enum EEnvironment
        {
            E_UNKNOWN_ENVIRONMENT,
            E_EXECUTION,
            E_DISPATCH,
            E_DOCUMENTEVENT
        };
 
        struct TJob2DocEventBinding
        {
            OUString m_sJobName;
            OUString m_sDocEvent;
 
            TJob2DocEventBinding(OUString sJobName ,
                                 OUString sDocEvent)
                : m_sJobName (std::move(sJobName ))
                , m_sDocEvent(std::move(sDocEvent))
            {}
        };
 
    // member
 
    private:
 
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
 
        EMode m_eMode;
 
        EEnvironment m_eEnvironment;
 
        OUString m_sAlias;
 
        OUString m_sService;
 
        OUString m_sContext;
 
        OUString m_sEvent;
 
        std::vector< css::beans::NamedValue > m_lArguments;
 
    // native interface
 
    public:
 
                 JobData( css::uno::Reference< css::uno::XComponentContext > xContext );
                 JobData( const JobData&                                                rCopy );
                 ~JobData(                                                                     );
 
        JobData& operator=( const JobData& rCopy );
 
        EMode                                        getMode                 () const;
        EEnvironment                                 getEnvironment          () const;
        OUString                              getEnvironmentDescriptor() const;
        OUString                              getService              () const;
        OUString                              getEvent                () const;
        css::uno::Sequence< css::beans::NamedValue > getConfig               () const;
        std::vector< css::beans::NamedValue >    getJobConfig            () const;
 
        bool                                     hasConfig               () const;
        bool                                     hasCorrectContext       ( std::u16string_view rModuleIdent ) const;
 
        void                                         setEnvironment (       EEnvironment                                  eEnvironment );
        void                                         setAlias       ( const OUString&                              sAlias       );
        void                                         setService     ( const OUString&                              sService     );
        void                                         setEvent       ( const OUString&                              sEvent       ,
                                                                      const OUString&                              sAlias       );
        void                                         setJobConfig   ( std::vector< css::beans::NamedValue >&& lArguments   );
        void                                         disableJob     (                                                                  );
 
        static std::vector< OUString > getEnabledJobsForEvent( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
                                                                std::u16string_view                                sEvent );
 
        static void appendEnabledJobsForEvent( const css::uno::Reference< css::uno::XComponentContext >&              rxContext,
                                               const OUString&                                                 sEvent ,
                                                     ::std::vector< JobData::TJob2DocEventBinding >& lJobs  );
 
    // private helper
 
    private:
 
        void impl_reset();
};
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */