summaryrefslogtreecommitdiffstats
path: root/src/gui/kdeext/KTmpStatusMsg.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/gui/kdeext/KTmpStatusMsg.h')
-rw-r--r--src/gui/kdeext/KTmpStatusMsg.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/src/gui/kdeext/KTmpStatusMsg.h b/src/gui/kdeext/KTmpStatusMsg.h
new file mode 100644
index 0000000..6fd512c
--- /dev/null
+++ b/src/gui/kdeext/KTmpStatusMsg.h
@@ -0,0 +1,88 @@
+// -*- c-basic-offset: 4 -*-
+
+/*
+ Rosegarden
+ A sequencer and musical notation editor.
+
+ This program is Copyright 2000-2008
+ Guillaume Laurent <[email protected]>,
+ Chris Cannam <[email protected]>,
+ Richard Bown <[email protected]>
+
+ The moral right of the authors to claim authorship of this work
+ has been asserted.
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License as
+ published by the Free Software Foundation; either version 2 of the
+ License, or (at your option) any later version. See the file
+ COPYING included with this distribution for more information.
+*/
+
+#ifndef KTMPSTATUSMSG_H
+#define KTMPSTATUSMSG_H
+
+class KMainWindow;
+
+/**
+ * A class to create a temporary message on KMainWindow's status bar
+ *
+ * Use as follows :
+ * { // some block of code starts here
+ * KTmpStatusMsg tmpMsg("doing something...", mainWindow);
+ *
+ * // do something
+ *
+ * } // the message goes away
+ *
+ */
+class KTmpStatusMsg
+{
+public:
+
+ /**
+ * Creates a new temporary status message on the status bar
+ * of the specified KMainWindow.
+ * The id of the text widget in the status bar can be specified
+ */
+ KTmpStatusMsg(const QString& msg, KMainWindow*, int id = m_defaultId);
+
+ ~KTmpStatusMsg();
+
+ /**
+ * Sets the message which will replace the temporary one in the
+ * status bar
+ */
+ static void setDefaultMsg(const QString&);
+
+ /**
+ * Returns the default message which will replace the temporary
+ * one in the status bar
+ */
+ static const QString& getDefaultMsg();
+
+ /**
+ * Sets the default id which will be used as the id of the text
+ * widget in the status bar
+ */
+ static void setDefaultId(int);
+
+ /**
+ * Returns the default id which will be used as id of the text
+ * widget in the status bar
+ */
+ static int getDefaultId();
+
+protected:
+
+ //--------------- Data members ---------------------------------
+
+ KMainWindow* m_mainWindow;
+ int m_id;
+
+ static int m_defaultId;
+ static QString m_defaultMsg;
+};
+
+#endif
+