Skip to content

Commit

Permalink
- implemented theme window search
Browse files Browse the repository at this point in the history
- using _search_modes for the search function
- when opening the search window no string will be displayed
- updated docs
  • Loading branch information
s-n-g committed Jul 14, 2019
1 parent 1e61b91 commit d3f1c9b
Show file tree
Hide file tree
Showing 7 changed files with 172 additions and 112 deletions.
7 changes: 5 additions & 2 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,13 @@ <h2 id="controls">Controls <span style="padding-left: 10px;"><sup style="font-si
DEL,x Delete selected station - -
t T Load theme / Toggle transparency [Valid] [Valid]
c Open Configuration window. - -
/ n N Search, go to next / previous result [Valid] [Valid]
? Show keys help [Valid] [Valid]
# Redraw window [Valid] [Valid]
Esc/q Quit - -
Esc/q/Left/h - Cancel / close window Cancel / close window</pre>
<p>The same logic applies to all <strong>PyRadio</strong> windows.</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows support changing the volume and muting / unmuting the player (provided that <strong>PyRadio</strong> is actually connected to a station).</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows - except the <em>Search window</em> - support changing the volume and muting / unmuting the player (provided that <strong>PyRadio</strong> is actually connected to a station).</p>
<h2 id="config-file">Config file <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
<p><strong>PyRadio</strong> upon its execution tries to read its configuration file (i.e. <em>~/.config/pyradio/config</em>). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and <strong><em>PyRadio</em></strong> will terminate.</p>
<p>The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented (as you can see <a href="pyradio/config">here</a>), so that manual editing is really easy. The best practice to manually edit this file is executing <strong><em>PyRadio</em></strong> with the <strong>-ocd</strong> command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.</p>
Expand Down Expand Up @@ -234,9 +235,11 @@ <h3 id="mplayer">MPlayer</h3>
<h2 id="search-function">Search function <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
<p>On any window presenting a list of items (stations, playlists, themes) a <strong>search function</strong> is available by pressing “<strong>/</strong>”.</p>
<p>The <em>Search Window</em> supports normal and extend editing and in session history.</p>
<p>One can always get help by pressing the “<strong>?</strong>” key.</p>
<p>The search will be case insensitive under <strong>python 3</strong>; it will be case sensitive under <strong>python 2</strong>.</p>
<p>After a search term has been successfully found, next occurrence can be obtained using the “<strong>n</strong>” key and previous occurrence can be obtained using the “<strong>N</strong>” key.</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> <strong>Python 2</strong> users are confined in typing ASCII characters only.</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Currently, the <strong>search function</strong> is available on the stations’ and playlists’ window only.</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Currently, the <strong>search function</strong> is available on the stations’ and playlists’ and themes’ window only.</p>
<h2 id="pyradio-themes">PyRadio Themes <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
<p><strong>PyRadio</strong> comes with 6 preconfigured (hard coded) themes:</p>
<ol type="1">
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ e Change station's encoding
DEL,x Delete selected station - -
t T Load theme / Toggle transparency [Valid] [Valid]
c Open Configuration window. - -
/ n N Search, go to next / previous result [Valid] [Valid]
? Show keys help [Valid] [Valid]
# Redraw window [Valid] [Valid]
Esc/q Quit - -
Expand All @@ -108,7 +109,7 @@ Esc/q/Left/h - Cancel / close windo

The same logic applies to all **PyRadio** windows.

**Note:** All windows support changing the volume and muting / unmuting the player (provided that **PyRadio** is actually connected to a station).
**Note:** All windows - except the *Search window* - support changing the volume and muting / unmuting the player (provided that **PyRadio** is actually connected to a station).


## Config file
Expand Down Expand Up @@ -335,11 +336,15 @@ On any window presenting a list of items (stations, playlists, themes) a **searc

The *Search Window* supports normal and extend editing and in session history.

One can always get help by pressing the "**?**" key.

The search will be case insensitive under **python 3**; it will be case sensitive under **python 2**.

After a search term has been successfully found, next occurrence can be obtained using the "**n**" key and previous occurrence can be obtained using the "**N**" key.

**Note:** **Python 2** users are confined in typing ASCII characters only.

**Note:** Currently, the **search function** is available on the stations' and playlists' window only.
**Note:** Currently, the **search function** is available on the stations' and playlists' and themes' window only.

## PyRadio Themes

Expand Down
8 changes: 6 additions & 2 deletions pyradio.1
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Quit
The same logic applies to all \fBpyradio\fR windows.

.IP \fBNote:
All windows support changing the volume and muting / unmuting the player (provided that it is actually connected to a station).
All windows - except the \fISearch window\fR - support changing the volume and muting / unmuting the player (provided that \fBpyradio\fR is actually connected to a station).

.SH CONFIG FILE
\fBpyradio\fR upon its execution tries to read its configuration file (i.e. \fI~/.config/pyradio/config\fR). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and \fBpyradio\fR will terminate.
Expand Down Expand Up @@ -348,13 +348,17 @@ On any window presenting a list of items (stations, playlists, themes) a \fBsear

The \fISearch Window\fR supports normal and extend editing and in session history.

One can always get help by pressing the "\fI?\fR" key.

The search will be case insensitive under \fBpython 3\fR; it will be case sensitive under \fBpython 2\fR.

After a search term has been successfully found, next occurrence can be obtained using the "\fIn\fR" key and previous occurrence can be obtained using the "\fIN\fR" key.

.IP \fBNote\fR
\fBPython 2\fR users are confined in typing ASCII characters only.

.IP \fBNote\fR
Currently, the \fBsearch function\fR is available on the stations' and playlists' window only.
Currently, the \fBsearch function\fR is available on the stations', playlists' and themes' window only.

.SH PYRADIO THEMES
.PP
Expand Down
Loading

0 comments on commit d3f1c9b

Please sign in to comment.