ScrollBars

Differences between revisions 8 and 21 (spanning 13 versions)
⇤ ← Revision 8 as of 2011-03-16 14:52:17 →
Size: 3488
Editor: 212-198-159-93
Comment:
← Revision 21 as of 2012-11-30 09:37:06 → ⇥
Size: 4924
Editor: mitya57
Comment: Fix blacklist URL
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
== Ayatana Scroll Bar Working Space == = Ayatana Scroll Bar Working Space =
Line 5: Line 5:
 * Where to Get It? == Where to Get It? ==
Line 14: Line 14:
Daily builds are now also available in the Unity PPA: [[http://www.launchpad.net/~unity/+archive/daily]]
Line 16: Line 18:
The source code is available as a simple bazaar branch: {{{bzr branch lp:ayatana-scrollbar}}} The source code is available as a simple bazaar branch: `bzr branch lp:ayatana-scrollbar`
Line 18: Line 20:
 * How to Test == How to Test ==
Line 21: Line 23:
{{{LIBOVERLAY_SCROLLBAR=foo <command> {{{
LIBOVERLAY_SCROLLBAR=foo <command>
Line 24: Line 27:
{{{LIBOVERLAY_SCROLLBAR=foo gedit {{{
LIBOVERLAY_SCROLLBAR=foo gedit
Line 27: Line 31:
 * Debugging Procedures == Debugging Procedures ==
Line 34: Line 38:
=== Test guidelines === == Test guidelines ==

You have to have an account in our tracking system. We are going to use it to generate data (it will be publicly available).

 * Go to our [[http://desktop.qa.ubuntu.com|Desktop Tracker]]
 * Click on “Log In” and “Create New Account”
 * You’re all set!
Line 38: Line 48:
- verify that the overlay scrollbar(s) appear in lieu of the classic GTK
scrollbars; both horizontal or vertical scrollbars
- verify that scrolling the content pane works with keyboard shortcuts
as they do normally; verify that the scrollbars do reflect the position
of the content pane in the overlay content area
- verify that scrollbar "thumbs" do appear when approaching the
scrollbars: the position of the thumbs should be outside, on the right,
of the window containing the content pane, except when the window is
close to the screen border, in which case it should be appear inside the
content pane
- verify that the scrollbar thumbs can scroll the content pane either
up/down or left/right depending on their orientation
- verify that scrollbar thumbs do disappear when the cursor is not in
close proximity with the scrollbars anymore		  1. verify that the overlay scrollbar(s) appear in lieu of the classic GTK scrollbars; both horizontal or vertical scrollbars
 1. verify that scrolling the content pane works with keyboard shortcuts as they do normally; verify that the scrollbars do reflect the position of the content pane in the overlay content area
 1. verify that scrollbar “thumbs” do appear when approaching the scrollbars: the position of the thumbs should be outside, on the right, of the window containing the content pane, except when the window is close to the screen border, in which case it should be appear inside the content pane
 1. verify that the scrollbar thumbs can scroll the content pane either up/down or left/right depending on their orientation
 1. verify that scrollbar thumbs do disappear when the cursor is not in close proximity with the scrollbars anymore
Line 53: Line 54:
Report bugs against only the scrollbar project for now, as we don't want
to spam other projects bug list with a feature that is ubuntu and even
ayatana specific.		 Report the results of the tests on the [[http://desktop.qa.ubuntu.com|Desktop Tracker]]. In the comment area of the report result, indicate which application you have tested.

Report bugs against only the scrollbar project for now, as we don't want to spam other projects bug list with a feature that is ubuntu and even Ayatana specific.
Line 58: Line 59:
- any kind of crashers, like when the application starts and tries to
display the window(s) containing scrollbars
- slowdowns in using scrollable areas; measurements can help judge how
much the scrollbar really impacts the application, or whether the
application is just slow due to other circumstances
- any other kind of anomaly obviously due to the scrollbars that impacts
the user experience		  * any kind of crashers, like when the application starts and tries to display the window(s) containing scrollbars
 * slowdowns in using scrollable areas; measurements can help judge how much the scrollbar really impacts the application, or whether the application is just slow due to other circumstances
 * any other kind of anomaly obviously due to the scrollbars that impacts the user experience
Line 67: Line 64:
=== Application Compatibility === Bug on the radar: [[https://bugs.launchpad.net/ayatana-scrollbar/+bugs?orderby=-importance]]
Line 69: Line 66:
Applications known to work
 * Nautilus
 * Evince
 * Gedit
 * Compis
 * Compiz Config Settings Manager
 * Devhelp
 * Totem
 * Rhythmbox
 * Xchat
 * Empathy
 * Cheese
 * Gwibber
 * Disk Usage Analizer
 * Disk Utility
 * Gnome System Monitor
 * Shotwell
 * Tomboy Notes
 * System preferences dialogs, like gnome-appearance-properties
 * ...		 == Application Compatibility ==

As of the Ubuntu 11.04 release, most GTK applications are known to work with the feature. However, only applications using the `gtk_scrolled_window` type are fully compatible with the new scrollbar.

Other applications will display the old scrollbars instead. This is the case for applications like gnome-terminal which programs interactions with scrollbars directly.
Line 93: Line 75:
|| || Browsers using the Webkit engine || [[Bug:732086]] ||
|| Banshee || extension list in preferences || ||
|| Brasero || when changing layout, cover editor, plugin list || ||		 || Firefox || XUL not supported || ||
|| Thunderbird || XUL not supported || ||
|| Eclipse || SWT not tested || ||
|| wxWidgets apps || pager not active || [[Bug:737661]] ||

In most cases, those applications are not really GTK+ applications, as they use only parts of the toolkits, in a way that is quite different from native GTK+ applications.

== Blacklist ==

This list documents the applications which have been blacklisted as of the Ubuntu 11.04 release. Either for incompatibility reasons, or to avoid breaking the software update mechanisms in Ubuntu.

 * apport-gtk
 * Banshee
 * codeblocks
 * codelite
 * eclipse
 * gnucash
 * meld
 * pgadmin3
 * synaptic
 * update-manager
 * vinagre
 * vmplayer
 * vmware

The official list is maintained directly in the code of the module, and is visible at: http://bazaar.launchpad.net/~ayatana-scrollbar-team/overlay-scrollbar/trunk/view/head:/os/os-scrollbar.c#L3946

Ayatana Scroll Bar Working Space

This area is a workspace for the scroll bars. For more information see the Canonical Design Blog for more information.

Where to Get It?

We provide packages for Natty: 

sudo add-apt-repository ppa:ayatana-scrollbar-team/release; sudo apt-get update
sudo apt-get install liboverlay-scrollbar-0.1-0

Daily builds are now also available in the Unity PPA: http://www.launchpad.net/~unity/+archive/daily

The project is hosted at: https://launchpad.net/ayatana-scrollbar

The source code is available as a simple bazaar branch: bzr branch lp:ayatana-scrollbar

How to Test

To test the overlay scrollbars, prefix each application invocation with: 

LIBOVERLAY_SCROLLBAR=foo <command>

for example 

LIBOVERLAY_SCROLLBAR=foo gedit

Debugging Procedures

In case you find bugs, please report them at: https://bugs.launchpad.net/ayatana-scrollbar/+filebug

In particular, mention the version of the overlay library tested, and of the application that exposes the problem. If the application crashed, apport should have captured a crash file which can help narrow down the issue more quickly.

Test guidelines

You have to have an account in our tracking system. We are going to use it to generate data (it will be publicly available).

  • Go to our Desktop Tracker

  • Click on “Log In” and “Create New Account”
  • You’re all set!

For each GTK-based application that uses scrollbars for its interface, here are the individual tests to conduct:

  1. verify that the overlay scrollbar(s) appear in lieu of the classic GTK scrollbars; both horizontal or vertical scrollbars
  2. verify that scrolling the content pane works with keyboard shortcuts as they do normally; verify that the scrollbars do reflect the position of the content pane in the overlay content area
  3. verify that scrollbar “thumbs” do appear when approaching the scrollbars: the position of the thumbs should be outside, on the right, of the window containing the content pane, except when the window is close to the screen border, in which case it should be appear inside the content pane
  4. verify that the scrollbar thumbs can scroll the content pane either up/down or left/right depending on their orientation
  5. verify that scrollbar thumbs do disappear when the cursor is not in close proximity with the scrollbars anymore

Report the results of the tests on the Desktop Tracker. In the comment area of the report result, indicate which application you have tested.

Report bugs against only the scrollbar project for now, as we don't want to spam other projects bug list with a feature that is ubuntu and even Ayatana specific.

In particular report:

  • any kind of crashers, like when the application starts and tries to display the window(s) containing scrollbars
  • slowdowns in using scrollable areas; measurements can help judge how much the scrollbar really impacts the application, or whether the application is just slow due to other circumstances
  • any other kind of anomaly obviously due to the scrollbars that impacts the user experience

Bug on the radar: https://bugs.launchpad.net/ayatana-scrollbar/+bugs?orderby=-importance

Application Compatibility

As of the Ubuntu 11.04 release, most GTK applications are known to work with the feature. However, only applications using the gtk_scrolled_window type are fully compatible with the new scrollbar.

Other applications will display the old scrollbars instead. This is the case for applications like gnome-terminal which programs interactions with scrollbars directly.

Applications known to have issues with the ayatana-scrollbar

Application

Description of the problem

Bug #

Firefox

XUL not supported

Thunderbird

XUL not supported

Eclipse

SWT not tested

wxWidgets apps

pager not active

737661

In most cases, those applications are not really GTK+ applications, as they use only parts of the toolkits, in a way that is quite different from native GTK+ applications.

Blacklist

This list documents the applications which have been blacklisted as of the Ubuntu 11.04 release. Either for incompatibility reasons, or to avoid breaking the software update mechanisms in Ubuntu.

  • apport-gtk
  • Banshee
  • codeblocks
  • codelite
  • eclipse
  • gnucash
  • meld
  • pgadmin3
  • synaptic
  • update-manager
  • vinagre
  • vmplayer
  • vmware

The official list is maintained directly in the code of the module, and is visible at: http://bazaar.launchpad.net/~ayatana-scrollbar-team/overlay-scrollbar/trunk/view/head:/os/os-scrollbar.c#L3946

Ayatana/ScrollBars (last edited 2012-11-30 09:37:06 by mitya57)