mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 09:00:44 +00:00
Add a small interface into Qt widgets to our own python wrapping
* This by no means replaces PySide2, but it allows python extensions to write simple UIs without needing to rely on PySide2, which might not be available (generally all windows builds have it as well as recent binary linux builds, but local windows builds may not and most linux builds probably won't).
This commit is contained in:
baldurk
@@ -0,0 +1,556 @@
|
||||
/******************************************************************************
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2020 Baldur Karlsson
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
******************************************************************************/
|
||||
|
||||
#include "MiniQtHelper.h"
|
||||
#include <QCheckBox>
|
||||
#include <QComboBox>
|
||||
#include <QFrame>
|
||||
#include <QGridLayout>
|
||||
#include <QGroupBox>
|
||||
#include <QHBoxLayout>
|
||||
#include <QPushButton>
|
||||
#include <QRadioButton>
|
||||
#include <QVBoxLayout>
|
||||
#include <QWidget>
|
||||
#include "Code/QRDUtils.h"
|
||||
#include "Code/pyrenderdoc/PythonContext.h"
|
||||
#include "Widgets/CollapseGroupBox.h"
|
||||
#include "Widgets/Extended/RDDoubleSpinBox.h"
|
||||
#include "Widgets/Extended/RDLabel.h"
|
||||
#include "Widgets/Extended/RDLineEdit.h"
|
||||
#include "Widgets/Extended/RDTextEdit.h"
|
||||
#include "Widgets/Extended/RDToolButton.h"
|
||||
|
||||
MiniQtHelper::MiniQtHelper(ICaptureContext &ctx) : m_Ctx(ctx)
|
||||
{
|
||||
}
|
||||
|
||||
MiniQtHelper::~MiniQtHelper()
|
||||
{
|
||||
PythonContext::ProcessExtensionWork([this]() {
|
||||
for(rdcpair<QWidget *, QMetaObject::Connection> &conn : m_Connections)
|
||||
{
|
||||
if(conn.second)
|
||||
QObject::disconnect(conn.second);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
void MiniQtHelper::AddWidgetCallback(QWidget *widget, QMetaObject::Connection connection)
|
||||
{
|
||||
// remember the connection and delete it python-safely at shutdown if it's still there
|
||||
m_Connections.push_back({widget, connection});
|
||||
|
||||
// when this widget is destroyed otherwise, delete it python-safely then.
|
||||
QObject::connect(widget, &QWidget::destroyed, [this, widget]() {
|
||||
PythonContext::ProcessExtensionWork([this, widget]() {
|
||||
for(int i = 0; i < m_Connections.count();)
|
||||
{
|
||||
if(m_Connections[i].first == widget)
|
||||
{
|
||||
QObject::disconnect(m_Connections[i].second);
|
||||
m_Connections.takeAt(i);
|
||||
continue;
|
||||
}
|
||||
|
||||
i++;
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateToplevelWidget(const rdcstr &windowTitle)
|
||||
{
|
||||
QWidget *ret = new QWidget();
|
||||
ret->setWindowTitle(windowTitle);
|
||||
ret->setLayout(new QVBoxLayout());
|
||||
return ret;
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetWidgetName(QWidget *widget, const rdcstr &name)
|
||||
{
|
||||
if(widget)
|
||||
widget->setObjectName(name);
|
||||
}
|
||||
|
||||
rdcstr MiniQtHelper::GetWidgetName(QWidget *widget)
|
||||
{
|
||||
if(widget)
|
||||
return widget->objectName();
|
||||
|
||||
return rdcstr();
|
||||
}
|
||||
|
||||
rdcstr MiniQtHelper::GetWidgetType(QWidget *widget)
|
||||
{
|
||||
if(widget)
|
||||
return widget->metaObject()->className();
|
||||
|
||||
return rdcstr();
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::FindChildByName(QWidget *parent, const rdcstr &name)
|
||||
{
|
||||
if(!parent)
|
||||
return NULL;
|
||||
|
||||
return parent->findChild<QWidget *>(name);
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::GetParent(QWidget *widget)
|
||||
{
|
||||
if(!widget)
|
||||
return NULL;
|
||||
|
||||
return widget->parentWidget();
|
||||
}
|
||||
|
||||
int MiniQtHelper::GetNumChildren(QWidget *widget)
|
||||
{
|
||||
if(!widget)
|
||||
return 0;
|
||||
|
||||
QLayout *layout = widget->layout();
|
||||
if(!layout)
|
||||
return 0;
|
||||
|
||||
return layout->count();
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::GetChild(QWidget *parent, int index)
|
||||
{
|
||||
if(!parent)
|
||||
return NULL;
|
||||
|
||||
QLayout *layout = parent->layout();
|
||||
if(!layout)
|
||||
return NULL;
|
||||
|
||||
QLayoutItem *item = layout->itemAt(index);
|
||||
if(!item)
|
||||
return NULL;
|
||||
|
||||
return item->widget();
|
||||
}
|
||||
|
||||
bool MiniQtHelper::ShowWidgetAsDialog(QWidget *widget)
|
||||
{
|
||||
QWidget *mainWindow = m_Ctx.GetMainWindow()->Widget();
|
||||
|
||||
m_CurrentDialog = new QDialog(mainWindow);
|
||||
m_CurrentDialog->setWindowFlags(m_CurrentDialog->windowFlags() & ~Qt::WindowContextHelpButtonHint);
|
||||
m_CurrentDialog->setWindowIcon(mainWindow->windowIcon());
|
||||
m_CurrentDialog->setWindowTitle(widget->windowTitle());
|
||||
m_CurrentDialog->setModal(true);
|
||||
|
||||
QVBoxLayout l;
|
||||
l.addWidget(widget);
|
||||
l.setMargin(3);
|
||||
|
||||
m_CurrentDialog->setLayout(&l);
|
||||
|
||||
bool success = (RDDialog::show(m_CurrentDialog) == QDialog::Accepted);
|
||||
|
||||
m_CurrentDialog->deleteLater();
|
||||
m_CurrentDialog = NULL;
|
||||
|
||||
return success;
|
||||
}
|
||||
|
||||
void MiniQtHelper::CloseCurrentDialog(bool success)
|
||||
{
|
||||
if(m_CurrentDialog)
|
||||
{
|
||||
if(success)
|
||||
m_CurrentDialog->accept();
|
||||
else
|
||||
m_CurrentDialog->reject();
|
||||
}
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateHorizontalContainer()
|
||||
{
|
||||
QWidget *ret = new QWidget();
|
||||
ret->setLayout(new QHBoxLayout(ret));
|
||||
return ret;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateVerticalContainer()
|
||||
{
|
||||
QWidget *ret = new QWidget();
|
||||
ret->setLayout(new QVBoxLayout(ret));
|
||||
return ret;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateGridContainer()
|
||||
{
|
||||
QWidget *ret = new QWidget();
|
||||
ret->setLayout(new QGridLayout(ret));
|
||||
return ret;
|
||||
}
|
||||
|
||||
void MiniQtHelper::ClearContainedWidgets(QWidget *parent)
|
||||
{
|
||||
if(!parent)
|
||||
return;
|
||||
|
||||
QLayout *layout = parent->layout();
|
||||
if(!layout)
|
||||
return;
|
||||
|
||||
while(layout->count())
|
||||
{
|
||||
layout->takeAt(0)->widget()->hide();
|
||||
}
|
||||
}
|
||||
|
||||
void MiniQtHelper::AddGridWidget(QWidget *parent, int row, int column, QWidget *child, int rowSpan,
|
||||
int columnSpan)
|
||||
{
|
||||
if(!parent || !child)
|
||||
return;
|
||||
|
||||
QLayout *layout = parent->layout();
|
||||
if(!layout)
|
||||
return;
|
||||
|
||||
QGridLayout *grid = qobject_cast<QGridLayout *>(layout);
|
||||
if(!grid)
|
||||
return;
|
||||
|
||||
grid->addWidget(child, row, column, rowSpan, columnSpan);
|
||||
}
|
||||
|
||||
void MiniQtHelper::AddWidget(QWidget *parent, QWidget *child)
|
||||
{
|
||||
if(!parent)
|
||||
return;
|
||||
|
||||
QLayout *layout = parent->layout();
|
||||
if(!layout)
|
||||
return;
|
||||
|
||||
QBoxLayout *box = qobject_cast<QBoxLayout *>(layout);
|
||||
if(!box)
|
||||
return;
|
||||
|
||||
box->addWidget(child);
|
||||
}
|
||||
|
||||
void MiniQtHelper::InsertWidget(QWidget *parent, int index, QWidget *child)
|
||||
{
|
||||
if(!parent)
|
||||
return;
|
||||
|
||||
QLayout *layout = parent->layout();
|
||||
if(!layout)
|
||||
return;
|
||||
|
||||
QBoxLayout *box = qobject_cast<QBoxLayout *>(layout);
|
||||
if(!box)
|
||||
return;
|
||||
|
||||
box->insertWidget(qMin(qMax(0, index), box->count()), child);
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetWidgetText(QWidget *widget, const rdcstr &text)
|
||||
{
|
||||
if(!widget)
|
||||
return;
|
||||
|
||||
widget->setWindowTitle(text);
|
||||
|
||||
#define SET_TEXT(TextWidget) \
|
||||
{ \
|
||||
TextWidget *w = qobject_cast<TextWidget *>(widget); \
|
||||
if(w) \
|
||||
return w->setText(text); \
|
||||
}
|
||||
|
||||
SET_TEXT(RDLabel);
|
||||
SET_TEXT(QLabel);
|
||||
SET_TEXT(RDLineEdit);
|
||||
SET_TEXT(RDTextEdit);
|
||||
SET_TEXT(QLineEdit);
|
||||
SET_TEXT(QTextEdit);
|
||||
SET_TEXT(QPushButton);
|
||||
SET_TEXT(RDToolButton);
|
||||
SET_TEXT(QToolButton);
|
||||
SET_TEXT(QCheckBox);
|
||||
SET_TEXT(QRadioButton);
|
||||
|
||||
{
|
||||
QGroupBox *w = qobject_cast<QGroupBox *>(widget);
|
||||
if(w)
|
||||
return w->setTitle(text);
|
||||
}
|
||||
{
|
||||
CollapseGroupBox *w = qobject_cast<CollapseGroupBox *>(widget);
|
||||
if(w)
|
||||
return w->setTitle(text);
|
||||
}
|
||||
}
|
||||
|
||||
rdcstr MiniQtHelper::GetWidgetText(QWidget *widget)
|
||||
{
|
||||
if(!widget)
|
||||
return rdcstr();
|
||||
|
||||
#define GET_TEXT(TextWidget) \
|
||||
{ \
|
||||
TextWidget *w = qobject_cast<TextWidget *>(widget); \
|
||||
if(w) \
|
||||
return w->text(); \
|
||||
}
|
||||
|
||||
GET_TEXT(RDLabel);
|
||||
GET_TEXT(QLabel);
|
||||
GET_TEXT(RDLineEdit);
|
||||
GET_TEXT(QLineEdit);
|
||||
GET_TEXT(QPushButton);
|
||||
GET_TEXT(RDToolButton);
|
||||
GET_TEXT(QToolButton);
|
||||
GET_TEXT(QCheckBox);
|
||||
GET_TEXT(QRadioButton);
|
||||
|
||||
{
|
||||
QTextEdit *w = qobject_cast<QTextEdit *>(widget);
|
||||
if(w)
|
||||
return w->toPlainText();
|
||||
}
|
||||
{
|
||||
RDTextEdit *w = qobject_cast<RDTextEdit *>(widget);
|
||||
if(w)
|
||||
return w->toPlainText();
|
||||
}
|
||||
|
||||
{
|
||||
QGroupBox *w = qobject_cast<QGroupBox *>(widget);
|
||||
if(w)
|
||||
return w->title();
|
||||
}
|
||||
{
|
||||
CollapseGroupBox *w = qobject_cast<CollapseGroupBox *>(widget);
|
||||
if(w)
|
||||
return w->title();
|
||||
}
|
||||
|
||||
// if all else failed, return the window title of the widget
|
||||
return widget->windowTitle();
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetWidgetFont(QWidget *widget, const rdcstr &font, int fontSize, bool bold,
|
||||
bool italic)
|
||||
{
|
||||
if(!widget)
|
||||
return;
|
||||
|
||||
QFont f = widget->font();
|
||||
|
||||
if(font.empty())
|
||||
f.setFamily(font);
|
||||
if(fontSize != 0)
|
||||
f.setPointSize(fontSize);
|
||||
f.setBold(bold);
|
||||
f.setItalic(italic);
|
||||
|
||||
widget->setFont(f);
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetWidgetEnabled(QWidget *widget, bool enabled)
|
||||
{
|
||||
if(!widget)
|
||||
return;
|
||||
|
||||
widget->setEnabled(enabled);
|
||||
}
|
||||
|
||||
bool MiniQtHelper::IsWidgetEnabled(QWidget *widget)
|
||||
{
|
||||
if(!widget)
|
||||
return false;
|
||||
|
||||
return widget->isEnabled();
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateGroupBox(bool collapsible)
|
||||
{
|
||||
QWidget *ret;
|
||||
if(collapsible)
|
||||
ret = new CollapseGroupBox();
|
||||
else
|
||||
ret = new QGroupBox();
|
||||
ret->setLayout(new QVBoxLayout());
|
||||
return ret;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateButton(WidgetCallback pressed)
|
||||
{
|
||||
QPushButton *w = new QPushButton();
|
||||
if(pressed)
|
||||
AddWidgetCallback(w, QObject::connect(w, &QPushButton::pressed,
|
||||
[this, w, pressed]() { pressed(&m_Ctx, w, rdcstr()); }));
|
||||
return w;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateLabel()
|
||||
{
|
||||
return new RDLabel();
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateCheckbox(WidgetCallback changed)
|
||||
{
|
||||
QCheckBox *w = new QCheckBox();
|
||||
if(changed)
|
||||
AddWidgetCallback(w, QObject::connect(w, &QCheckBox::stateChanged,
|
||||
[this, w, changed]() { changed(&m_Ctx, w, rdcstr()); }));
|
||||
return w;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateRadiobox(WidgetCallback changed)
|
||||
{
|
||||
QRadioButton *w = new QRadioButton();
|
||||
if(changed)
|
||||
AddWidgetCallback(w, QObject::connect(w, &QRadioButton::toggled,
|
||||
[this, w, changed]() { changed(&m_Ctx, w, rdcstr()); }));
|
||||
return w;
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetWidgetChecked(QWidget *checkableWidget, bool checked)
|
||||
{
|
||||
if(!checkableWidget)
|
||||
return;
|
||||
|
||||
QCheckBox *check = qobject_cast<QCheckBox *>(checkableWidget);
|
||||
QRadioButton *radio = qobject_cast<QRadioButton *>(checkableWidget);
|
||||
|
||||
if(check)
|
||||
check->setChecked(checked);
|
||||
else if(radio)
|
||||
radio->setChecked(checked);
|
||||
}
|
||||
|
||||
bool MiniQtHelper::IsWidgetChecked(QWidget *checkableWidget)
|
||||
{
|
||||
if(!checkableWidget)
|
||||
return false;
|
||||
|
||||
QCheckBox *check = qobject_cast<QCheckBox *>(checkableWidget);
|
||||
QRadioButton *radio = qobject_cast<QRadioButton *>(checkableWidget);
|
||||
|
||||
if(check)
|
||||
return check->isChecked();
|
||||
else if(radio)
|
||||
return radio->isChecked();
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateSpinbox(int decimalPlaces, double step)
|
||||
{
|
||||
RDDoubleSpinBox *ret = new RDDoubleSpinBox();
|
||||
ret->setSingleStep(step);
|
||||
ret->setDecimals(decimalPlaces);
|
||||
return ret;
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetSpinboxBounds(QWidget *spinbox, double minVal, double maxVal)
|
||||
{
|
||||
if(!spinbox)
|
||||
return;
|
||||
|
||||
RDDoubleSpinBox *spin = qobject_cast<RDDoubleSpinBox *>(spinbox);
|
||||
if(spin)
|
||||
spin->setRange(minVal, maxVal);
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetSpinboxValue(QWidget *spinbox, double value)
|
||||
{
|
||||
if(!spinbox)
|
||||
return;
|
||||
|
||||
RDDoubleSpinBox *spin = qobject_cast<RDDoubleSpinBox *>(spinbox);
|
||||
if(spin)
|
||||
spin->setValue(value);
|
||||
}
|
||||
|
||||
double MiniQtHelper::GetSpinboxValue(QWidget *spinbox)
|
||||
{
|
||||
if(!spinbox)
|
||||
return 0.0;
|
||||
|
||||
RDDoubleSpinBox *spin = qobject_cast<RDDoubleSpinBox *>(spinbox);
|
||||
if(spin)
|
||||
return spin->value();
|
||||
|
||||
return 0.0;
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateTextBox(bool singleLine, WidgetCallback changed)
|
||||
{
|
||||
if(singleLine)
|
||||
{
|
||||
RDLineEdit *w = new RDLineEdit();
|
||||
if(changed)
|
||||
AddWidgetCallback(w, QObject::connect(w, &RDLineEdit::textEdited, [this, w, changed]() {
|
||||
changed(&m_Ctx, w, w->text());
|
||||
}));
|
||||
return w;
|
||||
}
|
||||
else
|
||||
{
|
||||
RDTextEdit *w = new RDTextEdit();
|
||||
if(changed)
|
||||
AddWidgetCallback(w, QObject::connect(w, &RDTextEdit::textChanged, [this, w, changed]() {
|
||||
changed(&m_Ctx, w, w->toPlainText());
|
||||
}));
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
QWidget *MiniQtHelper::CreateComboBox(bool editable, WidgetCallback changed)
|
||||
{
|
||||
QComboBox *w = new QComboBox();
|
||||
if(changed)
|
||||
AddWidgetCallback(
|
||||
w, QObject::connect(w, &QComboBox::currentTextChanged,
|
||||
[this, w, changed](QString str) { changed(&m_Ctx, w, str); }));
|
||||
w->setEditable(editable);
|
||||
return w;
|
||||
}
|
||||
|
||||
void MiniQtHelper::SetComboOptions(QWidget *combo, const rdcarray<rdcstr> &options)
|
||||
{
|
||||
if(!combo)
|
||||
return;
|
||||
QComboBox *comb = qobject_cast<QComboBox *>(combo);
|
||||
|
||||
QStringList texts;
|
||||
|
||||
for(const rdcstr &o : options)
|
||||
texts << o;
|
||||
|
||||
comb->clear();
|
||||
comb->addItems(texts);
|
||||
}
|
||||
Reference in New Issue
Block a user