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

 /* This file is part of the KDE project
    Copyright (C) 2003-2012 Jarosław Staniek <staniek@kde.org>
 
    This program 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 program 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 program; see the file COPYING.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KEXI_H
 #define KEXI_H
 
 #include <QPointer>
 
 #include <KexiVersion.h>
 #include "kexiprojectdata.h"
 #include "kexidbconnectionset.h"
 #include "kexiprojectset.h"
 
 class QLabel;
 class KDbDriverManager;
 class KexiRecentProjects;
 
 namespace KexiPart
 {
 class Manager;
 }
 
 namespace Kexi
 {
 /*! Modes of view for the dialogs. Used mostly for parts and KexiWindow. */
 enum ViewMode {
     AllViewModes = 0, //!< Usable primarily in KexiPart::initInstanceActions()
     NoViewMode = 0,   //!< In KexiView::afterSwitchFrom() and KexiView::beforeSwitchTo()
                       //!< means that parent dialog of the view has not been defined yet.
     DataViewMode = 1,
     DesignViewMode = 2,
     TextViewMode = 4  //!< Also known as SQL View Mode
 };
 Q_DECLARE_FLAGS(ViewModes, ViewMode)
 
 /*! @return i18n'ed name of view mode @a mode. If @a withAmpersand is true,
  ampersands used for accelerators are included, e.g. "&Data View".*/
 KEXICORE_EXPORT QString nameForViewMode(ViewMode mode, bool withAmpersand = false);
 
 /*! @return icon name of view mode @a mode. */
 KEXICORE_EXPORT QString iconNameForViewMode(ViewMode mode);
 
 //! A set of known connections
 KEXICORE_EXPORT KexiDBConnectionSet& connset();
 
 //! A set available of project information
 KEXICORE_EXPORT KexiRecentProjects* recentProjects();
 
 //! shared driver manager
 KEXICORE_EXPORT KDbDriverManager& driverManager();
 
 //! shared part manager
 KEXICORE_EXPORT KexiPart::Manager& partManager();
 
 //! can be called to delete global objects like driverManager and partManager
 //! (and thus, all loaded factories/plugins)
 //! before KLibrary::~KLibrary() do this for us
 KEXICORE_EXPORT void deleteGlobalObjects();
 
 //some temporary flags
 
 //! false by default, flag loaded on main window startup
 KEXICORE_EXPORT bool& tempShowMacros();
 
 //! false by default, flag loaded on main window startup
 KEXICORE_EXPORT bool& tempShowScripts();
 
 //! false by default, flag loaded on main window startup
 KEXICORE_EXPORT bool& tempShowScripts();
 
 /*! Helper class for storing object status. */
 class KEXICORE_EXPORT ObjectStatus
 {
 public:
     ObjectStatus();
 
     ObjectStatus(const QString& message, const QString& description);
 
     ObjectStatus(const KDbResultable* resultable, const QString& message, const QString& description);
 
     ~ObjectStatus();
 
     const ObjectStatus& status() const;
 
     bool error() const;
 
     void setStatus(const QString& message, const QString& description);
 
     //! Note: for safety, \a dbObject needs to be derived from QObject,
     //! otherwise it won't be assigned
     void setStatus(const KDbResultable* resultable,
                    const QString& message = QString(), const QString& description = QString());
 
     void setStatus(KDbResultInfo* resultInfo,
                    const QString& message = QString(), const QString& description = QString());
 
     void setStatus(const KDbResultable* resultable, KDbResultInfo* resultInfo,
                    const QString& message = QString(), const QString& description = QString());
 
     void setStatus(const KDbResult& result, KDbResultInfo* resultInfo,
                    const QString& message = QString(), const QString& description = QString());
 
     void clearStatus();
 
     QString singleStatusString() const;
 
     void append(const ObjectStatus& otherStatus);
 
     const KDbResultable* resultable() const { return m_resultable; }
 
     //! Helper returning pseudo handler that just updates this ObjectStatus object
     //! by receiving a message
     operator KDbMessageHandler*();
 
     QString message, description;
 protected:
     const KDbResultable* m_resultable;
     KDbMessageHandler* m_msgHandler;
 };
 
 /*! \return icon name for default file-based driver
  (typically icon for something like "application/x-kexiproject-sqlite").
  @see KDb::defaultFileBasedDriverMimeType() */
 KEXICORE_EXPORT QString defaultFileBasedDriverIconName();
 
 /*! \return icon for default file-based driver
  (typically icon for something like "application/x-kexiproject-sqlite").
  If contains special workaround to properly load mimetype icon according to current theme,
  at least needed for Breeze.
  @see KDb::defaultFileBasedDriverIconName() */
 KEXICORE_EXPORT QIcon defaultFileBasedDriverIcon();
 
 /*! \return icon name for database servers. */
 KEXICORE_EXPORT QString serverIconName();
 
 /*! \return icon for database servers. */
 KEXICORE_EXPORT QIcon serverIcon();
 
 /*! @return message text "Kexi could have been incorrectly installed or started.
             The application will be closed." useful for critical errors. */
 KEXICORE_EXPORT QString appIncorrectlyInstalledMessage();
 
 //! @return base path (without the filename for file-based connection data @a connectionData.
 //! Empty string is returned if @a connectionData does not point to a file-based connection with
 //! database name specified.
 KEXICORE_EXPORT QString basePathForProject(const KDbConnectionData& connectionData);
 
 //! @return @c true if this is a Kexi app instance
 //! @c false is returned e.g. for test apps that are based on Kexi.
 //! This function is useful to decide if certain actions should be performed that only
 //! belong to the "real" Kexi app, for example updating a list of recent documents
 //! or collecting usage information.
 //! The check is performed by comparing component name of KAboutData to the string "kexi".
 KEXICORE_EXPORT bool isKexiInstance();
 
 }//namespace Kexi
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(Kexi::ViewModes)
 
 //! Displays information that feature "feature_name" is not availabe in the current application version
 KEXICORE_EXPORT void KEXI_UNFINISHED(
     const QString& feature_name, const QString& extra_text = QString());
 
 //! Like KEXI_UNFINISHED but returns new label instance with expected text
 KEXICORE_EXPORT QLabel *KEXI_UNFINISHED_LABEL(
     const QString& feature_name, const QString& extra_text = QString());
 
 //! Like above - for use inside KexiActionProxy subclass - reuses feature name from shared action's text
 #define KEXI_UNFINISHED_SHARED_ACTION(action_name) \
     KEXI_UNFINISHED(sharedAction(action_name) ? sharedAction(action_name)->text() : QString())
 
 //! Implementation of plugin's entry point
 #define KEXI_PLUGIN_FACTORY(class_name, name) \
     K_PLUGIN_FACTORY_WITH_JSON(class_name ## Factory, name, registerPlugin<class_name>();)
 
 #endif