Skip to content

Commit

Permalink
Update README to state >= GTK+ 3.18 dependency...
Browse files Browse the repository at this point in the history
... for get_scroll_lock_state. Reported in #1.
  • Loading branch information
adrianiainlam authored Sep 19, 2016
1 parent f462ecb commit 73e4946
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ distributions. To install the rest, run:

sudo apt-get install python3-gi xdotool

**Note**: [`gdk_keymap_get_scroll_lock_state ()`][gtkdoc-scroll] is only
available since GTK+ 3.18. The earliest Ubuntu release that supports
GTK+ 3.18 is 16.04 (Xenial). This means that if you use an older version
you will have to ignore Scroll lock functionality (See [Examples](#examples)).

[gtkdoc-scroll]: https://developer.gnome.org/gdk3/stable/gdk3-Keyboard-Handling.html#gdk-keymap-get-scroll-lock-state

## Usage

1. Install the dependencies listed above.
Expand Down Expand Up @@ -79,6 +86,8 @@ Default appearance in a French locale.

## Known bugs

### Pressing Scroll Lock does nothing

It seems to be a common problem that Scroll Lock is not usable in Ubuntu.
To solve this, do the following (assuming US keyboard):

Expand Down Expand Up @@ -110,6 +119,16 @@ modified. [Original source][origsrc] by dm+ on PCLinuxOS-Forums.
[origsrc]: http://www.pclinuxos.com/forum/index.php/topic,125690.msg1052201.html?PHPSESSID=2qsv83lve6dgd0ivq14bfcjc30#msg1052201
[quotesrc]: http://askubuntu.com/a/597757/274080

### X11Keymap has no attribute 'get_scroll_lock_state'

If running the script gives the error message

AttributeError: 'gtk.gdk.X11Keymap' object has no attribute 'get_scroll_lock_state'

then your installed GTK+ version is probably older than 3.18, which
does not support `get_scroll_lock_state`. Either hide all Scroll Lock
functionality (See [Examples](#examples)), or upgrade your system.

## Localization

As motivated by Issue #1, this script has been localized to French (with
Expand Down

0 comments on commit 73e4946

Please sign in to comment.