File indexing completed on 2024-05-12 16:39:41

 /* This file is part of the KDE project
    Copyright (C) 2004-2017 Jarosław Staniek <staniek@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KEXI_STARTUPDATA_H
 #define KEXI_STARTUPDATA_H
 
 #include <QString>
 #include <QCommandLineOption>
 #include "kexicore_export.h"
 
 #include <KDbTristate>
 
 class KexiProjectData;
 class KexiCommandLineOptions;
 
 //! Startup data used for storing results of startup operations in Kexi.
 //! @see KexiStartupHandler
 class KEXICORE_EXPORT KexiStartupData
 {
 public:
     enum Action {
         DoNothing,
         CreateBlankProject,
         CreateFromTemplate,
         OpenProject,
         ImportProject,
         ShowWelcomeScreen,
         Exit
     };
 
     /*! Data required to perform import action.
      It is set by KexiStartupHandler::detectActionForFile()
      if a need for project/data importing has been detected. */
     class KEXICORE_EXPORT Import
     {
     public:
         Import();
         operator bool() const;
         QString fileName;
         QString mimeType;
     };
 
     KexiStartupData();
     virtual ~KexiStartupData();
 
     //! @return singleton Startup Handler singleton.
     //! @see KexiStartupHandler::global()
     static KexiStartupData* global();
 
     Action action() const;
 
     //! \return project data of a project that should be opened (for action()==OpenProject)
     KexiProjectData *projectData();
 
     //! \return import action's data needed to perform import (for action()==ImportProject)
     KexiStartupData::Import importActionData() const;
 
     /*! \return true if the Design Mode is forced for this project.
       Used on startup (by --design-mode comman line switch). */
     bool forcedDesignMode() const;
 
     /*! \return true if the User Mode is forced for this project.
       Used on startup (by --user-mode comman line switch).
       By default this is false. */
     bool forcedUserMode() const;
 
     /*! \return true if the Project Navigator should be visible even if User Mode is on. */
     bool isProjectNavigatorVisible() const;
 
     /*! \return true if the main menu (usually displayed as the tabbed toolbar) should be visible. */
     bool isMainMenuVisible() const;
 
     /*! \return true if Kexi started fullscreen.
       Used on startup (by --fullscreen commandline switch). */
     bool forcedFullScreen() const;
 
     //! @return command line options
     KexiCommandLineOptions options() const;
 
     //! Parses the options and arguments
     //! @return true on success
     tristate parseOptions(const QStringList &arguments,
                           const QList<QCommandLineOption> &extraOptions = QList<QCommandLineOption>());
 
     //! @return true if the option @a option was passed to the application
     bool isSet(const QCommandLineOption & option) const;
 
     //! @return value for option @a option
     QString value(const QCommandLineOption &option) const;
 
     //! @return list of values for option @a option
     QStringList values(const QCommandLineOption &option) const;
 
     //! @return a list of positional arguments.
     //! These are all of the arguments that were not recognized as part of an option.
     QStringList positionalArguments() const;
 
     QString helpText() const;
 
 protected:
     void setAction(Action action);
 
     //! Set project data of a project that should be opened (for action()==OpenProject).
     //! The ownership is passed.
     void setProjectData(KexiProjectData *data);
 
     void setImportActionData(KexiStartupData::Import import);
 
     void setForcedDesignMode(bool set);
 
     void setForcedUserMode(bool set);
 
     void setProjectNavigatorVisible(bool set);
 
     void setMainMenuVisible(bool set);
 
     void setForcedFullScreen(bool set);
 
 private:
     class Private;
     Private* const d;
 };
 
 #endif