You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
111 lines
2.5 KiB
111 lines
2.5 KiB
/*
|
|
Rosegarden
|
|
A MIDI and audio sequencer and musical notation editor.
|
|
|
|
This program is Copyright 2000-2008
|
|
Guillaume Laurent <glaurent@telegraph-road.org>,
|
|
Chris Cannam <cannam@all-day-breakfast.com>,
|
|
Richard Bown <richard.bown@ferventsoftware.com>
|
|
|
|
The moral rights of Guillaume Laurent, Chris Cannam, and Richard
|
|
Bown to claim authorship of this work have been asserted.
|
|
|
|
Other copyrights also apply to some parts of this work. Please
|
|
see the AUTHORS file and individual file headers for details.
|
|
|
|
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 _RG_BASETOOL_H_
|
|
#define _RG_BASETOOL_H_
|
|
|
|
#include <tqobject.h>
|
|
#include <tqstring.h>
|
|
|
|
|
|
class TQPopupMenu;
|
|
class KXMLGUIFactory;
|
|
|
|
|
|
namespace Rosegarden
|
|
{
|
|
|
|
|
|
|
|
/**
|
|
* BaseTool : base tool class, just handles RMB menu creation and
|
|
* handling by a BaseToolBox
|
|
*
|
|
*/
|
|
class BaseTool : public TQObject
|
|
{
|
|
TQ_OBJECT
|
|
|
|
|
|
friend class BaseToolBox;
|
|
|
|
public:
|
|
|
|
virtual ~BaseTool();
|
|
|
|
/**
|
|
* Is called by the parent View (EditView or SegmentCanvas) when
|
|
* the tool is set as current.
|
|
* Add any setup here (e.g. setting the mouse cursor shape)
|
|
*/
|
|
virtual void ready();
|
|
|
|
/**
|
|
* Is called by the parent View (EditView or SegmentCanvas) after
|
|
* the tool is put away.
|
|
* Add any cleanup here
|
|
*/
|
|
virtual void stow();
|
|
|
|
/**
|
|
* Show the menu if there is one
|
|
*/
|
|
virtual void showMenu();
|
|
|
|
/**
|
|
* Retrieve current status-line type help for the tool, if any
|
|
*/
|
|
virtual TQString getCurrentContextHelp() const;
|
|
|
|
signals:
|
|
void showContextHelp(const TQString &);
|
|
|
|
protected:
|
|
/**
|
|
* Create a new BaseTool
|
|
*
|
|
* \a menuName : the name of the menu defined in the XML rc file
|
|
*/
|
|
BaseTool(const TQString& menuName, KXMLGUIFactory*, TQObject* parent);
|
|
|
|
virtual void createMenu() = 0;
|
|
virtual bool hasMenu() { return false; }
|
|
|
|
virtual void setContextHelp(const TQString &help);
|
|
virtual void clearContextHelp() { setContextHelp(""); }
|
|
|
|
//--------------- Data members ---------------------------------
|
|
|
|
TQString m_menuName;
|
|
TQPopupMenu* m_menu;
|
|
|
|
KXMLGUIFactory* m_parentFactory;
|
|
|
|
TQString m_contextHelp;
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
#endif
|