mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-25 11:22:55 +00:00
87 lines
3.1 KiB
C
87 lines
3.1 KiB
C
|
/***************************************************************************
|
||
|
|
* Copyright 2007 Hamish Rodda <rodda@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 General Public License for more details. *
|
||
|
|
* *
|
||
|
|
* You should have received a copy of the GNU Library General Public *
|
||
|
|
* License along with this program; if not, write to the *
|
||
|
|
* Free Software Foundation, Inc., *
|
||
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
|
||
|
|
***************************************************************************/
|
||
|
|
|
||
|
|
#ifndef KDEVPLATFORM_ISTATUS_H
|
||
|
|
#define KDEVPLATFORM_ISTATUS_H
|
||
|
|
|
||
|
|
#include "interfacesexport.h"
|
||
|
|
#include <QtCore/QObject>
|
||
|
|
|
||
|
|
namespace KDevelop {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An interface for plugins, languages etc. to provide status updates.
|
||
|
|
* Plugins only have to implement this extension interface, registration
|
||
|
|
* happens automagically.
|
||
|
|
* Regular QObjects can register themselves through IUiController like so:
|
||
|
|
* @code
|
||
|
|
* Foo* f; // some QObject that implements IStatus
|
||
|
|
* ICore::self()->uiController()->registerStatus(f);
|
||
|
|
* @endcode
|
||
|
|
*/
|
||
|
|
class KDEVPLATFORMINTERFACES_EXPORT IStatus
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
virtual ~IStatus();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return a name for the status object
|
||
|
|
*/
|
||
|
|
virtual QString statusName() const = 0;
|
||
|
|
|
||
|
|
Q_SIGNALS:
|
||
|
|
/**
|
||
|
|
* Request the current message for this plugin to be cleared.
|
||
|
|
*/
|
||
|
|
virtual void clearMessage( IStatus* ) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Request a status \a message to be shown for this plugin, with a given \a timeout.
|
||
|
|
*
|
||
|
|
* \param message Message to display
|
||
|
|
* \param timeout Timeout in miliseconds, or pass 0 for no timeout.
|
||
|
|
*/
|
||
|
|
virtual void showMessage( IStatus*, const QString & message, int timeout = 0) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Request an error \a message to be shown for this plugin, with a given \a timeout.
|
||
|
|
*
|
||
|
|
* \param message Message to display
|
||
|
|
* \param timeout Timeout in miliseconds, or pass 0 for no timeout.
|
||
|
|
*/
|
||
|
|
virtual void showErrorMessage(const QString & message, int timeout = 0) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Hide the progress bar.
|
||
|
|
*/
|
||
|
|
virtual void hideProgress( IStatus* ) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Show a progress bar, with the given \a percentage.
|
||
|
|
*/
|
||
|
|
virtual void showProgress( IStatus*, int minimum, int maximum, int value) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
Q_DECLARE_INTERFACE( KDevelop::IStatus, "org.kdevelop.IStatus" )
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|