mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-03-19 13:20:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated ButtonWidget onclick description

Browse Source
This commit is contained in:
Jonathan Frederic 2013-11-04 23:53:41 +00:00
parent 4c23d2c7a1
commit 6110e1c307
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
IPython/html/widgets/widget_button.py
View File

@ -40,12 +40,17 @@ class ButtonWidget(Widget):
def on_click(self, callback, remove=False):
"""Register a callback to execute when the button is clicked.
"""Register a callback to execute when the button is clicked. The
callback can either accept no parameters or one sender parameter:
- callback()
- callback(sender)
If the callback has a sender parameter, the ButtonWidget instance that
called the callback will be passed into the method as the sender.
Parameters
----------
remove : bool (optional)
Set to tru to remove the callback from the list of callbacks."""
Set to true to remove the callback from the list of callbacks."""
if remove:
self._click_handlers.remove(callback)
else: