Skip to content
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

Add some tooltips for things that felt like they could use them #1443

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add some tooltips for things that felt like they could use them #1443

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7be617c
Add some tooltips for things.
cme Jan 8, 2022
d55a8f6
Remote HTML from tooltips
cme Jan 9, 2022
dc5f349
Merge branch 'master' into dev-tooltips
cme Jan 14, 2022
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
4 changes: 4 additions & 0 deletions src/gui/src/PatternEditor/PatternEditorPanel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ PatternEditorPanel::PatternEditorPanel( QWidget *pParent )
m_pResolutionLbl = new ClickableLabel( m_pSizeResol, QSize( 28, 13 ), HydrogenApp::get_instance()->getCommonStrings()->getResolutionLabel(), ClickableLabel::Color::Dark );
m_pResolutionLbl->setAlignment( Qt::AlignRight );
m_pResolutionLbl->move( 155, 4 );
QString sTip = tr( "<html><p>Resolution of the pattern grid sets how finely notes may be placed.</p>"
"<p>Hold <b>Alt</b> to place or move notes independently of the grid.</p></html>" );
m_pResolutionLbl->setToolTip( sTip );
m_pResolutionCombo->setToolTip( sTip );


m_pRec = new QGroupBox( nullptr );
Expand Down
62 changes: 60 additions & 2 deletions src/gui/src/PreferencesDialog/PreferencesDialog_UI.ui
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<enum>QTabWidget::Rounded</enum>
</property>
<property name="currentIndex">
<number>0</number>
<number>1</number>
Copy link
Contributor

Choose a reason for hiding this comment

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

We need a unit test for this one :D

</property>
<widget class="QWidget" name="GeneralTab">
<attribute name="title">
Expand Down Expand Up @@ -91,20 +91,29 @@
</item>
<item>
<widget class="QCheckBox" name="hideKeyboardCursor">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Hide the keyboard input cursor when editing using the mouse&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string>&amp;Hide keyboard input cursor</string>
</property>
</widget>
</item>
<item>
<widget class="QCheckBox" name="useLashCheckbox">
<property name="toolTip">
<string>Use the LASH Audio Session Handler</string>
</property>
<property name="text">
<string extracomment="LASH (acronym for LASH Audio Session Handler) is a protocol allowing for session management in Linux (recalling songs, preferences, and JACK port connections).">Use &amp;LASH</string>
</property>
</widget>
</item>
<item>
<widget class="QCheckBox" name="patternFollowsSongCheckbox">
<property name="toolTip">
<string>Keep a currently-playing pattern selected when playing in Song Mode</string>
</property>
<property name="text">
<string>Selected pattern follows song</string>
</property>
Expand Down Expand Up @@ -211,6 +220,9 @@
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0" colspan="2">
<widget class="QLabel" name="pathToRubberbandExLable">
<property name="toolTip">
<string>Rubberband is used to time-stretch or compress samples to playback at different pitches.</string>
</property>
<property name="text">
<string>Path to the Rubberband command-line utility</string>
</property>
Expand All @@ -237,6 +249,9 @@
<height>0</height>
</size>
</property>
<property name="toolTip">
<string>Rubberband is used to time-stretch or compress samples to playback at different pitches.</string>
</property>
</widget>
</item>
</layout>
Expand Down Expand Up @@ -266,7 +281,11 @@
<widget class="QComboBox" name="driverComboBox"/>
</item>
<item row="4" column="1">
<widget class="HostAPIComboBox" name="portaudioHostAPIComboBox"/>
<widget class="HostAPIComboBox" name="portaudioHostAPIComboBox">
<property name="toolTip">
<string>Underlying system API to use</string>
</property>
</widget>
</item>
<item row="9" column="1">
<widget class="QComboBox" name="trackOutputComboBox">
Expand All @@ -293,6 +312,9 @@
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="toolTip">
<string>Audio output device to send Hydrogen audio to</string>
</property>
<property name="editable">
<bool>true</bool>
</property>
Expand All @@ -313,6 +335,9 @@
</item>
<item row="4" column="0">
<widget class="QLabel" name="portaudioHostAPILabel">
<property name="toolTip">
<string>Underlying system API to use</string>
</property>
<property name="text">
<string>Host API</string>
</property>
Expand Down Expand Up @@ -342,6 +367,9 @@
<height>22</height>
</size>
</property>
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Audio buffer size (in frames). This generally determines the &lt;span style=&quot; font-weight:700;&quot;&gt;minimum&lt;/span&gt; audio latency the system can achieve. Actual audio latency will be greater.&lt;/p&gt;&lt;p&gt;Selecting a buffer size that is too small may lead to audible glitches, particularly if the system becomes more heavily loaded.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Use with caution.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
Copy link
Contributor

Choose a reason for hiding this comment

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

There is one potential problem with HTML in the translatable text. When using a standard editor to do the translation all the HTML code is displayed in plain text (not sure whether there are more elaborated ones out there). If the translator does not know HTML she might end up translating things like "body" or "style". Not quite sure if that ever happened but at least ones I encountered mismatching brackets in a translation which made Qt unable to render them

</property>
<property name="minimum">
<number>100</number>
</property>
Expand Down Expand Up @@ -381,20 +409,29 @@
</item>
<item row="5" column="0">
<widget class="QLabel" name="audioDeviceLbl">
<property name="toolTip">
<string>Audio output device to send Hydrogen audio to</string>
</property>
<property name="text">
<string>Device</string>
</property>
</widget>
</item>
<item row="7" column="0">
<widget class="QLabel" name="latencyTargetLabel">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Set the target latency that the audio system attempts to achieve.&lt;/p&gt;&lt;p&gt;Selecting a latency that is too small may lead to audible glitches, particularly if the system becomes more heavily loaded.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Use with caution.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string>Latency target</string>
</property>
</widget>
</item>
<item row="8" column="1">
<widget class="QComboBox" name="sampleRateComboBox">
<property name="toolTip">
<string>Audio sample rate (or frame rate) to use. 44100 frames/second is CD-quality.</string>
</property>
<property name="currentIndex">
<number>0</number>
</property>
Expand Down Expand Up @@ -428,6 +465,9 @@
<height>22</height>
</size>
</property>
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Audio buffer size (in frames). This generally determines the &lt;span style=&quot; font-weight:700;&quot;&gt;minimum&lt;/span&gt; audio latency the system can achieve. Actual audio latency will be greater.&lt;/p&gt;&lt;p&gt;Selecting a buffer size that is too small may lead to audible glitches, particularly if the system becomes more heavily loaded.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Use with caution.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string>Buffer size</string>
</property>
Expand All @@ -441,6 +481,9 @@
<height>22</height>
</size>
</property>
<property name="toolTip">
<string>Audio sample rate (or frame rate) to use. 44100 frames/second is CD-quality.</string>
</property>
<property name="text">
<string>Sample rate</string>
</property>
Expand All @@ -450,6 +493,9 @@
<layout class="QHBoxLayout" name="horizontalLayout_11">
<item>
<widget class="QSpinBox" name="latencyTargetSpinBox">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Set the target latency that the audio system attempts to achieve.&lt;/p&gt;&lt;p&gt;Selecting a latency that is too small may lead to audible glitches, particularly if the system becomes more heavily loaded.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Use with caution.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="maximum">
<number>48000</number>
</property>
Expand All @@ -460,6 +506,9 @@
</item>
<item>
<widget class="QLabel" name="latencyValueLabel">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Set the target latency that the audio system attempts to achieve.&lt;/p&gt;&lt;p&gt;Selecting a latency that is too small may lead to audible glitches, particularly if the system becomes more heavily loaded.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Use with caution.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string/>
</property>
Expand Down Expand Up @@ -505,6 +554,9 @@
</item>
<item>
<widget class="QPushButton" name="restartDriverBtn">
<property name="toolTip">
<string>Restart audio system to apply currently selected parameters.</string>
</property>
<property name="text">
<string>Apply and restart output</string>
</property>
Expand Down Expand Up @@ -586,13 +638,19 @@
<layout class="QHBoxLayout" name="horizontalLayout_31">
<item>
<widget class="QLabel" name="resapelingLbl">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Interpolation method used when rendering samples at different frequencies.&lt;/p&gt;&lt;p&gt;Linear interpolation is fastest and provides reasonable sound quality. Others are higher quality but have higher CPU usage penalties.&lt;/p&gt;&lt;p&gt;The differences will be most noticable where samples are played back at much different frequencies from the audio system sample rate (eg. low quality samples, particularly played at low pitch).&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="text">
<string>Interpolate resampling</string>
</property>
</widget>
</item>
<item>
<widget class="QComboBox" name="resampleComboBox">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Interpolation method used when rendering samples at different frequencies.&lt;/p&gt;&lt;p&gt;Linear interpolation is fastest and provides reasonable sound quality. Others are higher quality but have higher CPU usage penalties.&lt;/p&gt;&lt;p&gt;The differences will be most noticable where samples are played back at much different frequencies from the audio system sample rate (eg. low quality samples, particularly played at low pitch).&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<item>
<property name="text">
<string>Linear</string>
Expand Down
9 changes: 6 additions & 3 deletions src/gui/src/SongEditor/SongEditorPanel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,19 +129,22 @@ SongEditorPanel::SongEditorPanel(QWidget *pParent)

// Two buttons sharing the same position and either of them is
// shown unpressed.
m_pModeActionSingleBtn = new Button( pBackPanel, QSize( 23, 19 ), Button::Type::Push, "single_layer.svg", "", false, QSize( 15, 11 ), tr( "single pattern mode") );
m_pModeActionSingleBtn = new Button( pBackPanel, QSize( 23, 19 ), Button::Type::Push, "single_layer.svg", "",
false, QSize( 15, 11 ), tr( "Focused single pattern mode") );
m_pModeActionSingleBtn->move( 170, 26 );
m_pModeActionSingleBtn->setVisible( pPref->patternModePlaysSelected() );
connect( m_pModeActionSingleBtn, SIGNAL( pressed() ), this, SLOT( modeActionBtnPressed() ) );

m_pModeActionMultipleBtn = new Button( pBackPanel, QSize( 23, 19 ), Button::Type::Push, "multiple_layers.svg", "", false, QSize( 19, 15 ), tr( "stacked pattern mode") );
m_pModeActionMultipleBtn = new Button( pBackPanel, QSize( 23, 19 ), Button::Type::Push, "multiple_layers.svg", "",
false, QSize( 19, 15 ),
tr( "stacked pattern mode: show and play multiple patterns at a time") );
m_pModeActionMultipleBtn->move( 170, 26 );
m_pModeActionMultipleBtn->hide();
m_pModeActionMultipleBtn->setVisible( pPref->patternModePlaysSelected() );
connect( m_pModeActionMultipleBtn, SIGNAL( pressed() ), this, SLOT( modeActionBtnPressed() ) );
setModeActionBtn( Preferences::get_instance()->patternModePlaysSelected() );

// ZOOM
// ZOOM
m_pHScrollBar = new QScrollBar( Qt::Horizontal, nullptr );
m_pHScrollBar->setObjectName( "SongEditorPanel HScrollBar" );
connect( m_pHScrollBar, SIGNAL(valueChanged(int)), this, SLOT( hScrollTo(int) ) );
Expand Down