Source code for bokeh.models.widgets.buttons

''' Various kinds of button widgets.

'''
from __future__ import absolute_import

import warnings

from ...core.enums import ButtonType
from ...core.has_props import abstract, HasProps
from ...core.properties import Bool, Enum, Instance, Int, List, Override, String, Tuple

from ..callbacks import Callback

from .icons import AbstractIcon
from .widget import Widget

@abstract
[docs]class ButtonLike(HasProps): ''' Shared properties for button-like widgets. ''' button_type = Enum(ButtonType, help=""" A style for the button, signifying it's role. """) @property def type(self): warnings.warn( """ Property 'type' was deprecated in Bokeh 0.12.0 and will be removed. Use 'button_type' instead. """) return self.button_type @type.setter def type(self, type): warnings.warn( """ Property 'type' was deprecated in Bokeh 0.12.0 and will be removed. Use 'button_type' instead. """) self.button_type = type __deprecated_attributes__ = ('type',)
@abstract
[docs]class AbstractButton(Widget, ButtonLike): ''' A base class that defines common properties for all button types. ''' label = String("Button", help=""" The text label for the button to display. """) icon = Instance(AbstractIcon, help=""" An optional image appearing to the left of button's text. """) callback = Instance(Callback, help=""" A callback to run in the browser whenever the button is activated. """)
[docs]class Button(AbstractButton): ''' A click button. ''' clicks = Int(0, help=""" A private property used to trigger ``on_click`` event handler. """)
[docs] def on_click(self, handler): ''' Set up a handler for button clicks. Args: handler (func) : handler function to call when button is clicked. Returns: None ''' self.on_change('clicks', lambda attr, old, new: handler())
[docs]class Toggle(AbstractButton): ''' A two-state toggle button. ''' label = Override(default="Toggle") active = Bool(False, help=""" The initial state of a button. Also used to trigger ``on_click`` event handler. """)
[docs] def on_click(self, handler): """ Set up a handler for button state changes (clicks). Args: handler (func) : handler function to call when button is toggled. Returns: None """ self.on_change('active', lambda attr, old, new: handler(new))