kindred/create
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

[Macro Menu] add Recent macros to Macro menu + list size preference. Executes selected macro or if Shift+click opens macro in editor.

Browse Source
This commit is contained in:
mwganson
2020-06-14 15:47:30 -05:00
committed by Yorik van Havre
parent 2ef0017cf6
commit 4a0d127dae
10 changed files with 491 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
src/Gui/Action.cpp
View File

@@ -44,11 +44,16 @@
#include <Base/Tools.h>
#include "Action.h"
#include "Application.h"
#include "BitmapFactory.h"
#include "Command.h"
#include "DlgUndoRedo.h"
#include "DlgWorkbenchesImp.h"
#include "Document.h"
#include "EditorView.h"
#include "FileDialog.h"
#include "Macro.h"
#include "MainWindow.h"
#include "PythonEditor.h"
#include "WhatsThis.h"
#include "Widgets.h"
#include "Workbench.h"
@@ -818,6 +823,195 @@ void RecentFilesAction::save()
// --------------------------------------------------------------------
/* TRANSLATOR Gui::RecentMacrosAction */
RecentMacrosAction::RecentMacrosAction ( Command* pcCmd, QObject * parent )
: ActionGroup( pcCmd, parent ), visibleItems(4), maximumItems(20)
{
restore();
}
RecentMacrosAction::~RecentMacrosAction()
{
}
/** Adds the new item to the recent files. */
void RecentMacrosAction::appendFile(const QString& filename)
{
// restore the list of recent files
QStringList files = this->files();
// if already inside remove and prepend it
files.removeAll(filename);
files.prepend(filename);
setFiles(files);
save();
// update the XML structure and save the user parameter to disk (#0001989)
bool saveParameter = App::GetApplication().GetParameterGroupByPath
("User parameter:BaseApp/Preferences/General")->GetBool("SaveUserParameter", true);
if (saveParameter) {
ParameterManager* parmgr = App::GetApplication().GetParameterSet("User parameter");
parmgr->SaveDocument(App::Application::Config()["UserParameter"].c_str());
}
}
/**
* Set the list of recent macro files. For each item an action object is
* created and added to this action group.
*/
void RecentMacrosAction::setFiles(const QStringList& files)
{
ParameterGrp::handle hGrp = App::GetApplication().GetUserParameter().GetGroup("BaseApp")
->GetGroup("Preferences")->GetGroup("RecentMacros");
this->shortcut_modifiers = hGrp->GetASCII("ShortcutModifiers","Ctrl+Shift+");
this->shortcut_count = std::min<int>(hGrp->GetInt("ShortcutCount",3),9);//max = 9, e.g. Ctrl+Shift+9
this->visibleItems = hGrp->GetInt("RecentMacros",12);
QList<QAction*> recentFiles = _group->actions();
int numRecentFiles = std::min<int>(recentFiles.count(), files.count());
for (int index = 0; index < numRecentFiles; index++) {
QFileInfo fi(files[index]);
QString accel = tr(QString::fromLatin1(shortcut_modifiers.c_str())\
.append(QString::number(index+1,10)).toStdString().c_str());
recentFiles[index]->setText(QString::fromLatin1("%1 %2").arg(index+1).arg(fi.baseName()));
recentFiles[index]->setStatusTip(tr("Run macro %1 (Shift+click to edit) shortcut: %2").arg(files[index]).arg(accel));
recentFiles[index]->setToolTip(files[index]); // set the full name that we need later for saving
recentFiles[index]->setData(QVariant(index));
if (index < shortcut_count){
recentFiles[index]->setShortcut(accel);
}
recentFiles[index]->setVisible(true);
}
// if less file names than actions
numRecentFiles = std::min<int>(numRecentFiles, this->visibleItems);
for (int index = numRecentFiles; index < recentFiles.count(); index++) {
recentFiles[index]->setVisible(false);
recentFiles[index]->setText(QString());
recentFiles[index]->setToolTip(QString());
}
}
/**
* Returns the list of defined recent files.
*/
QStringList RecentMacrosAction::files() const
{
QStringList files;
QList<QAction*> recentFiles = _group->actions();
for (int index = 0; index < recentFiles.count(); index++) {
QString file = recentFiles[index]->toolTip();
if (file.isEmpty())
break;
files.append(file);
}
return files;
}
void RecentMacrosAction::activateFile(int id)
{
// restore the list of recent files
QStringList files = this->files();
if (id < 0 || id >= files.count())
return; // no valid item
QString filename = files[id];
QFileInfo fi(filename);
if (!fi.exists() || !fi.isFile()) {
QMessageBox::critical(getMainWindow(), tr("File not found"), tr("The file '%1' cannot be opened.").arg(filename));
files.removeAll(filename);
setFiles(files);
}
else {
if (QApplication::keyboardModifiers() == Qt::ShiftModifier){ //open for editing on Shift+click
PythonEditor* editor = new PythonEditor();
editor->setWindowIcon(Gui::BitmapFactory().iconFromTheme("applications-python"));
PythonEditorView* edit = new PythonEditorView(editor, getMainWindow());
edit->setDisplayName(PythonEditorView::FileName);
edit->open(filename);
edit->resize(400, 300);
getMainWindow()->addWindow(edit);
getMainWindow()->appendRecentMacro(filename);
edit->setWindowTitle(fi.fileName());
} else { //execute macro on normal (non-shifted) click
try {
getMainWindow()->appendRecentMacro(fi.filePath());
Application::Instance->macroManager()->run(Gui::MacroManager::File, fi.filePath().toUtf8());
// after macro run recalculate the document
if (Application::Instance->activeDocument())
Application::Instance->activeDocument()->getDocument()->recompute();
}
catch (const Base::SystemExitException&) {
// handle SystemExit exceptions
Base::PyGILStateLocker locker;
Base::PyException e;
e.ReportException();
}
}
}
}
void RecentMacrosAction::resizeList(int size)
{
this->visibleItems = size;
int diff = this->visibleItems - this->maximumItems;
// create new items if needed
for (int i=0; i<diff; i++)
_group->addAction(QLatin1String(""))->setVisible(false);
setFiles(files());
}
/** Loads all recent files from the preferences. */
void RecentMacrosAction::restore()
{
ParameterGrp::handle hGrp = App::GetApplication().GetUserParameter().GetGroup("BaseApp")->GetGroup("Preferences");
if (hGrp->HasGroup("RecentMacros")) {
hGrp = hGrp->GetGroup("RecentMacros");
// we want at least 20 items but we do only show the number of files
// that is defined in user parameters
this->visibleItems = hGrp->GetInt("RecentMacros", this->visibleItems);
this->shortcut_count = hGrp->GetInt("ShortcutCount", 3); // number of shortcuts
this->shortcut_modifiers = hGrp->GetASCII("ShortcutModifiers","Ctrl+Shift+");
}
int count = std::max<int>(this->maximumItems, this->visibleItems);
for (int i=0; i<count; i++)
_group->addAction(QLatin1String(""))->setVisible(false);
std::vector<std::string> MRU = hGrp->GetASCIIs("MRU");
QStringList files;
for (std::vector<std::string>::iterator it = MRU.begin(); it!=MRU.end();++it)
files.append(QString::fromUtf8(it->c_str()));
setFiles(files);
}
/** Saves all recent files to the preferences. */
void RecentMacrosAction::save()
{
ParameterGrp::handle hGrp = App::GetApplication().GetUserParameter().GetGroup("BaseApp")
->GetGroup("Preferences")->GetGroup("RecentMacros");
int count = hGrp->GetInt("RecentMacros", this->visibleItems); // save number of files
hGrp->Clear();
// count all set items
QList<QAction*> recentFiles = _group->actions();
int num = std::min<int>(count, recentFiles.count());
for (int index = 0; index < num; index++) {
QString key = QString::fromLatin1("MRU%1").arg(index);
QString value = recentFiles[index]->toolTip();
if (value.isEmpty())
break;
hGrp->SetASCII(key.toLatin1(), value.toUtf8());
}
hGrp->SetInt("RecentMacros", count); // restore
hGrp->SetInt("ShortcutCount", this->shortcut_count);
hGrp->SetASCII("ShortcutModifiers",this->shortcut_modifiers.c_str());
}
// --------------------------------------------------------------------
UndoAction::UndoAction (Command* pcCmd,QObject * parent)
: Action(pcCmd, parent)
{

32
src/Gui/Action.h
View File

@@ -210,6 +210,38 @@ private:
int maximumItems; /**< Number of maximum items */
};
// --------------------------------------------------------------------
/**
* The RecentMacrosAction class holds a menu listed with the recent macros
* that were executed, edited, or created
*/
class GuiExport RecentMacrosAction : public ActionGroup
{
Q_OBJECT
public:
RecentMacrosAction (Command* pcCmd, QObject * parent = 0);
virtual ~RecentMacrosAction();
void appendFile(const QString&);
void activateFile(int);
void resizeList(int);
private:
void setFiles(const QStringList&);
QStringList files() const;
void restore();
void save();
private:
int visibleItems; /**< Number of visible items */
int maximumItems; /**< Number of maximum items */
std::string shortcut_modifiers; /**< default = "Ctrl+Shift+" */
int shortcut_count; /**< Number of dynamic shortcuts to create -- default = 3*/
};
// --------------------------------------------------------------------
/**

41
src/Gui/CommandStd.cpp
View File

@@ -172,6 +172,46 @@ Action * StdCmdRecentFiles::createAction(void)
return pcAction;
}
//===========================================================================
// Std_RecentMacros
//===========================================================================
DEF_STD_CMD_C(StdCmdRecentMacros)
StdCmdRecentMacros::StdCmdRecentMacros()
:Command("Std_RecentMacros")
{
sGroup = QT_TR_NOOP("Macro");
sMenuText = QT_TR_NOOP("Recent macros");
sToolTipText = QT_TR_NOOP("Recent macro list");
sWhatsThis = "Std_RecentMacros";
sStatusTip = QT_TR_NOOP("Recent macro list");
eType = NoTransaction;
}
/**
* Opens the recent macro at position \a iMsg in the menu.
* If the macro does not exist or cannot be loaded this item is removed
* from the list.
*/
void StdCmdRecentMacros::activated(int iMsg)
{
RecentMacrosAction* act = qobject_cast<RecentMacrosAction*>(_pcAction);
if (act) act->activateFile( iMsg );
}
/**
* Creates the QAction object containing the recent macros.
*/
Action * StdCmdRecentMacros::createAction(void)
{
RecentMacrosAction* pcAction = new RecentMacrosAction(this, getMainWindow());
pcAction->setObjectName(QLatin1String("recentMacros"));
pcAction->setDropDownMenu(true);
applyCommandData(this->className(), pcAction);
return pcAction;
}
//===========================================================================
// Std_About
//===========================================================================
@@ -766,6 +806,7 @@ void CreateStdCommands(void)
rcCmdMgr.addCommand(new StdCmdCommandLine());
rcCmdMgr.addCommand(new StdCmdWorkbench());
rcCmdMgr.addCommand(new StdCmdRecentFiles());
rcCmdMgr.addCommand(new StdCmdRecentMacros());
rcCmdMgr.addCommand(new StdCmdWhatsThis());
rcCmdMgr.addCommand(new StdCmdPythonHelp());
rcCmdMgr.addCommand(new StdCmdOnlineHelp());

4
src/Gui/DlgMacroExecuteImp.cpp
View File

@@ -274,6 +274,7 @@ void DlgMacroExecuteImp::accept()
QFileInfo fi(dir, item->text(0));
try {
getMainWindow()->appendRecentMacro(fi.filePath());
Application::Instance->macroManager()->run(Gui::MacroManager::File, fi.filePath().toUtf8());
// after macro run recalculate the document
if (Application::Instance->activeDocument())
@@ -334,6 +335,7 @@ void DlgMacroExecuteImp::on_editButton_clicked()
edit->open(file);
edit->resize(400, 300);
getMainWindow()->addWindow(edit);
getMainWindow()->appendRecentMacro(file);
if (mitem->systemWide) {
editor->setReadOnly(true);
@@ -341,7 +343,6 @@ void DlgMacroExecuteImp::on_editButton_clicked()
shownName = QString::fromLatin1("%1[*] - [%2]").arg(item->text(0), tr("Read-only"));
edit->setWindowTitle(shownName);
}
close();
}
@@ -380,6 +381,7 @@ void DlgMacroExecuteImp::on_createButton_clicked()
editor->setWindowIcon(Gui::BitmapFactory().iconFromTheme("applications-python"));
PythonEditorView* edit = new PythonEditorView(editor, getMainWindow());
edit->open(fi.absoluteFilePath());
getMainWindow()->appendRecentMacro(fi.absoluteFilePath());
edit->setWindowTitle(QString::fromLatin1("%1[*]").arg(fn));
edit->resize(400, 300);
getMainWindow()->addWindow(edit);

213
src/Gui/DlgSettingsMacro.ui
View File

@@ -48,25 +48,21 @@
<string>Macro recording settings</string>
</property>
<layout class="QGridLayout">
<property name="margin">
<property name="leftMargin">
<number>9</number>
</property>
<property name="topMargin">
<number>9</number>
</property>
<property name="rightMargin">
<number>9</number>
</property>
<property name="bottomMargin">
<number>9</number>
</property>
<property name="spacing">
<number>6</number>
</property>
<item row="3" column="0">
<spacer>
<property name="orientation">
<enum>Qt::Vertical</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>20</width>
<height>40</height>
</size>
</property>
</spacer>
</item>
<item row="2" column="0">
<widget class="QGroupBox" name="groupBox4">
<property name="title">
@@ -76,7 +72,16 @@
<property name="spacing">
<number>6</number>
</property>
<property name="margin">
<property name="leftMargin">
<number>11</number>
</property>
<property name="topMargin">
<number>11</number>
</property>
<property name="rightMargin">
<number>11</number>
</property>
<property name="bottomMargin">
<number>11</number>
</property>
<item>
@@ -112,8 +117,8 @@
</widget>
</item>
<item>
<widget class="Gui::PrefFileChooser" name="MacroPath_2">
<property name="fileName">
<widget class="Gui::PrefFileChooser" name="MacroPath_2" native="true">
<property name="fileName" stdset="0">
<string>FullScript.FCScript</string>
</property>
<property name="prefEntry" stdset="0">
@@ -133,7 +138,16 @@
<string>Gui commands</string>
</property>
<layout class="QGridLayout">
<property name="margin">
<property name="leftMargin">
<number>11</number>
</property>
<property name="topMargin">
<number>11</number>
</property>
<property name="rightMargin">
<number>11</number>
</property>
<property name="bottomMargin">
<number>11</number>
</property>
<property name="spacing">
@@ -186,20 +200,26 @@
<string>Macro path</string>
</property>
<layout class="QGridLayout">
<property name="margin">
<property name="leftMargin">
<number>11</number>
</property>
<property name="topMargin">
<number>11</number>
</property>
<property name="rightMargin">
<number>11</number>
</property>
<property name="bottomMargin">
<number>11</number>
</property>
<property name="spacing">
<number>6</number>
</property>
<item row="0" column="0">
<widget class="Gui::PrefFileChooser" name="MacroPath">
<widget class="Gui::PrefFileChooser" name="MacroPath" native="true">
<property name="toolTip">
<string>The directory in which the application will search for macros</string>
</property>
<property name="mode">
<enum>Gui::FileChooser::Directory</enum>
</property>
<property name="prefEntry" stdset="0">
<cstring>MacroPath</cstring>
</property>
@@ -214,10 +234,152 @@
</layout>
</widget>
</item>
<item row="2" column="0">
<widget class="QGroupBox" name="recentmacrosgroupBox">
<property name="title">
<string>Recent macros menu</string>
</property>
<layout class="QGridLayout" name="recentmacrosgridLayout">
<item row="0" column="0">
<widget class="QLabel" name="recentMacroListLabel">
<property name="text">
<string>Size of recent macro list</string>
</property>
</widget>
</item>
<item row="0" column="1">
<spacer name="horizontalSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item row="0" column="5">
<widget class="Gui::PrefSpinBox" name="RecentMacros">
<property name="toolTip">
<string>How many macros should be listed in recent macros list</string>
</property>
<property name="value">
<number>12</number>
</property>
<property name="prefEntry" stdset="0">
<cstring>RecentMacros</cstring>
</property>
<property name="prefPath" stdset="0">
<cstring>RecentMacros</cstring>
</property>
</widget>
</item>
<item row="1" column="0">
<widget class="QLabel" name="recentMacroListShortcutCountLabel">
<property name="text">
<string>Shortcut count</string>
</property>
</widget>
</item>
<item row="1" column="1">
<spacer name="horizontalSpacer_2">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item row="1" column="5">
<widget class="Gui::PrefSpinBox" name="ShortcutCount">
<property name="toolTip">
<string>How many recent macros should have shortcuts</string>
</property>
<property name="value">
<number>3</number>
</property>
<property name="prefEntry" stdset="0">
<cstring>ShortcutCount</cstring>
</property>
<property name="prefPath" stdset="0">
<cstring>RecentMacros</cstring>
</property>
</widget>
</item>
<item row="2" column="0">
<widget class="QLabel" name="ShorcutModifiersLabel">
<property name="text">
<string>Keyboard Modifiers</string>
</property>
</widget>
</item>
<item row="2" column="1">
<spacer name="horizontalSpacer_3">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item row="2" column="5" colspan="3">
<widget class="Gui::PrefLineEdit" name="ShortcutModifiers">
<property name="toolTip">
<string>Keyboard modifiers, default = Ctrl+Shift+</string>
</property>
<property name="prefEntry" stdset="0">
<cstring>ShortcutModifiers</cstring>
</property>
<property name="prefPath" stdset="0">
<cstring>RecentMacros</cstring>
</property>
</widget>
</item>
</layout>
</widget>
</item>
<item row="3" column="0">
<spacer>
<property name="orientation">
<enum>Qt::Vertical</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>20</width>
<height>40</height>
</size>
</property>
</spacer>
</item>
</layout>
</widget>
<layoutdefault spacing="6" margin="11"/>
<customwidgets>
<customwidget>
<class>Gui::PrefLineEdit</class>
<extends>QLineEdit</extends>
<header>Gui/PrefWidgets.h</header>
</customwidget>
<customwidget>
<class>Gui::PrefSpinBox</class>
<extends>QSpinBox</extends>
<header>Gui/PrefWidgets.h</header>
</customwidget>
<customwidget>
<class>Gui::PrefCheckBox</class>
<extends>QCheckBox</extends>
<header>Gui/PrefWidgets.h</header>
</customwidget>
<customwidget>
<class>Gui::FileChooser</class>
<extends>QWidget</extends>
@@ -228,11 +390,6 @@
<extends>Gui::FileChooser</extends>
<header>Gui/PrefWidgets.h</header>
</customwidget>
<customwidget>
<class>Gui::PrefCheckBox</class>
<extends>QCheckBox</extends>
<header>Gui/PrefWidgets.h</header>
</customwidget>
</customwidgets>
<resources/>
<connections>

22
src/Gui/DlgSettingsMacroImp.cpp
View File

@@ -22,10 +22,11 @@
#include "PreCompiled.h"
#include "DlgSettingsMacroImp.h"
#include "ui_DlgSettingsMacro.h"
#include "Action.h"
#include "Application.h"
#include "MainWindow.h"
using namespace Gui::Dialog;
@@ -58,6 +59,18 @@ DlgSettingsMacroImp::~DlgSettingsMacroImp()
{
// no need to delete child widgets, Qt does it all for us
}
/** Sets the size of the recent macros list from the user parameters.
* @see RecentMacrosAction
* @see StdCmdRecentMacros
*/
void DlgSettingsMacroImp::setRecentMacroSize()
{
RecentMacrosAction *recent = getMainWindow()->findChild<RecentMacrosAction *>(QLatin1String("recentMacros"));
if (recent) {
ParameterGrp::handle hGrp = WindowParameter::getDefaultParameter()->GetGroup("RecentMacros");
recent->resizeList(hGrp->GetInt("RecentMacros", 4));
}
}
void DlgSettingsMacroImp::saveSettings()
{
@@ -68,6 +81,10 @@ void DlgSettingsMacroImp::saveSettings()
ui->PConsoleCheckBox->onSave();
ui->FileLogCheckBox->onSave();
ui->MacroPath_2->onSave();
ui->RecentMacros->onSave();
ui->ShortcutModifiers->onSave();
ui->ShortcutCount->onSave();
setRecentMacroSize();
}
void DlgSettingsMacroImp::loadSettings()
@@ -79,6 +96,9 @@ void DlgSettingsMacroImp::loadSettings()
ui->PConsoleCheckBox->onRestore();
ui->FileLogCheckBox->onRestore();
ui->MacroPath_2->onRestore();
ui->RecentMacros->onRestore();
ui->ShortcutModifiers->onRestore();
ui->ShortcutCount->onRestore();
}
/**

1
src/Gui/DlgSettingsMacroImp.h
View File

@@ -52,6 +52,7 @@ protected:
private:
std::unique_ptr<Ui_DlgSettingsMacro> ui;
void setRecentMacroSize();
};
} // namespace Dialog

9
src/Gui/MainWindow.cpp
View File

@@ -1320,6 +1320,15 @@ void MainWindow::appendRecentFile(const QString& filename)
}
}
void MainWindow::appendRecentMacro(const QString& filename)
{
RecentMacrosAction *recent = this->findChild<RecentMacrosAction *>
(QString::fromLatin1("recentMacros"));
if (recent) {
recent->appendFile(filename);
}
}
void MainWindow::updateActions(bool delay)
{
//make it safe to call before the main window is actually created

4
src/Gui/MainWindow.h
View File

@@ -118,6 +118,10 @@ public:
* MRU: Appends \a file to the list of recent files.
*/
void appendRecentFile(const QString& filename);
/**
* MRU: Appends \a macro to the list of recent macros.
*/
void appendRecentMacro(const QString& filename);
/**
* Returns true that the context menu contains the 'Customize...' menu item.
*/

1
src/Gui/Workbench.cpp
View File

@@ -671,6 +671,7 @@ MenuItem* StdWorkbench::setupMenuBar() const
*macro << "Std_DlgMacroRecord"
<< "Std_MacroStopRecord"
<< "Std_DlgMacroExecute"
<< "Std_RecentMacros"
<< "Separator"
<< "Std_DlgMacroExecuteDirect"
<< "Std_MacroAttachDebugger"