Package wx :: Package lib :: Package agw :: Module knobctrl
[frames | no frames]

Module wx.lib.agw.knobctrl

Description
===========

KnobCtrl lets the user select a numerical value by rotating it. It works like a
scrollbar: just set the ticks range property and read the value property in the
associated KC_EVENT_ANGLE_CHANGING/KC_EVENT_ANGLE_CHANGED events. Simple but
effective. It can be easily used if you want to simulate the volume knob of a
music player or similar functionalities.


Events
======

KnobCtrl implements two events that can be intercepted by the user:

  - KC_EVENT_ANGLE_CHANGING
  - KC_EVENT_ANGLE_CHANGED

The first one can be "vetoed" by eliminating the event.Skip() at the end of the
event handler.


Supported Platforms
===================

KnobCtrl has been tested on the following platforms:
  * Windows (Windows XP);
  * Linux Ubuntu (Dapper 6.06)


License And Version:
===================

KnobCtrl is freeware and distributed under the wxPython license. 


Latest Revision: Andrea Gavana @ 15 Oct 2008, 22.30 GMT
Version 0.1

Classes
BufferedWindow A Buffered window class.
KnobCtrl This class can be used to simulate a knob volume control often found in PC music players.
KnobCtrlEvent Represent details of the events that the KnobCtrl object sends.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:51:50 2009 http://epydoc.sf.net