Skip to content

chore: Improve look of hwlabel to better match manual #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Holzhaus wants to merge 3 commits into from
Closed

chore: Improve look of hwlabel to better match manual #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4144dd
Controller settings: allow :hwbtn:`LABEL` syntax for styling
ronso0 Apr 4, 2024
35ed4cd
use :hwbtn: for Traktor S4 Mk3 settings
ronso0 Apr 4, 2024
e9788a4
chore: Improve look of hwlabel to better match manual
Holzhaus Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions res/controllers/Traktor Kontrol S4 MK3.hid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@
variable="gridButtonBlinkOverBeat"
type="boolean"
default="false"
label="Make the <tt style='background-color: #111111; color: #d9d9d9;padding: 2px;'>GRID</tt> button blink over the beat">
label="Make the :hwbtn:`GRID` button blink over the beat">
<description>
This will make the &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;GRID&lt;/tt&gt; button blink when the track is going over a detected beat. This can help adjusting the beat grid or BPM.
This will make the :hwbtn:`GRID` button blink when the track is going over a detected beat. This can help adjusting the beat grid or BPM.
</description>
</option>
<option
Expand Down Expand Up @@ -176,9 +176,9 @@
variable="useKeylockOnMaster"
type="boolean"
default="false"
label="Keylock on &lt;tt style='background-color: #111111; color: #d9d9d9;padding: 2px;'&gt;SHIFT&lt;/tt&gt;+&lt;tt style='background-color: #111111; color: #d9d9d9;padding: 2px;'&gt;MASTER&lt;/tt&gt; instead of &lt;tt style='background-color: #111111; color: #d9d9d9;padding: 2px;'&gt;SHIFT&lt;/tt&gt;+&lt;tt style='background-color: #111111; color: #d9d9d9;padding: 2px;'&gt;SYNC&lt;/tt&gt;">
label="Keylock on :hwbtn:`SHIFT`+:hwbtn:`MASTER` instead of :hwbtn:`SHIFT`+:hwbtn:`SYNC`">
<description>
This setting toggles the keylock on push instead of release, as there is a long-press action on &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;SHIFT&lt;/tt&gt;+&lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;SYNC&lt;/tt&gt; (copy key).
This setting toggles the keylock on push instead of release, as there is a long-press action on :hwbtn:`SHIFT`+:hwbtn:`SYNC` (copy key).
</description>
</option>
<option
Expand Down Expand Up @@ -369,7 +369,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key">20</value>
<description>First column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>First column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
<option
variable="librarySortableColumns2Value"
Expand All @@ -396,7 +396,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key">20</value>
<description>Second column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>Second column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
<option
variable="librarySortableColumns3Value"
Expand All @@ -423,7 +423,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key">20</value>
<description>Third column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>Third column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
<option
variable="librarySortableColumns4Value"
Expand All @@ -450,7 +450,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key" default="true">20</value>
<description>Fourth column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>Fourth column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
<option
variable="librarySortableColumns5Value"
Expand All @@ -477,7 +477,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key">20</value>
<description>Fifth column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>Fifth column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
<option
variable="librarySortableColumns6Value"
Expand All @@ -504,7 +504,7 @@
<value label="Times Played">18</value>
<value label="Rating">19</value>
<value label="Key">20</value>
<description>Sixth column when iterating over sortable library columns using &lt;tt style="background-color: #111111; color: #d9d9d9;padding: 2px;"&gt;VIEW&lt;/tt&gt;+Library Encoder press</description>
<description>Sixth column when iterating over sortable library columns using :hwbtn:`VIEW`+Library Encoder press</description>
</option>
</row>
</group>
Expand Down
30 changes: 28 additions & 2 deletions src/controllers/legacycontrollersettings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,32 @@

#include "moc_legacycontrollersettings.cpp"

namespace {

// Regex that allows to use :hwbtn:`LABELSTRING` in xml controller settings xml
const QRegularExpression kHwbtnRe(QStringLiteral(":hwbtn:`([^`]*)`"));

const QString kHwbtnStyleWrapper = QStringLiteral(
"<span style='"
"background: #343131;"
"color: #d9d9d9;"
"font-size: 70%;"
"font-weight: 600;"
"line-height: 120%;"
"text-transform: uppercase;"
Copy link
Copy Markdown
Owner

@ronso0 ronso0 Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't enforce that tbh.

Copy link
Copy Markdown
Owner

@ronso0 ronso0 Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd pick this commit right away, I'd only remove that line
Okay?.

Copy link
Copy Markdown
Owner

@ronso0 ronso0 Apr 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't enforce that tbh.

I know we do that in the manual though.
In the end, let's keep it for consistency (instead of changing it in the manual, for each doc...)

// Padding does only work with block and table-cell elements, not
// inline span. Hence, wrapping the string in `&nbsp;` is the only way
// to get the desired look here. See the Qt documentation for details:
// https://doc.qt.io/qt-6/richtext-html-subset.html#css-properties
// \\1 is the RegEx match group 1.
"'>&nbsp;\\1&nbsp;</span>");

QString replaceMarkupStyleStr(QString str) {
return str.replace(kHwbtnRe, kHwbtnStyleWrapper);
}

} // namespace

LegacyControllerSettingBuilder* LegacyControllerSettingBuilder::instance() {
static LegacyControllerSettingBuilder* s_self = nullptr;

Expand All @@ -32,11 +58,11 @@ LegacyControllerSettingBuilder::LegacyControllerSettingBuilder() {

AbstractLegacyControllerSetting::AbstractLegacyControllerSetting(const QDomElement& element) {
m_variableName = element.attribute("variable").trimmed();
m_label = element.attribute("label", m_variableName).trimmed();
m_label = replaceMarkupStyleStr(element.attribute("label", m_variableName).trimmed());

QDomElement description = element.firstChildElement("description");
if (!description.isNull()) {
m_description = description.text().trimmed();
m_description = replaceMarkupStyleStr(description.text().trimmed());
}
}

Expand Down