Added get_status() function to the CheckButtons widget

[DanHickstein]

This allows the user to query the status of a CheckButtons instance using
check.get_status() as discussed in issue #5930 (comment)

Here is an adaptation of the CheckButtons example to show this functionality:

import numpy as np
import matplotlib.pyplot as plt
from matplotlib.widgets import CheckButtons

t = np.arange(0.0, 2.0, 0.01)
s0 = np.sin(2*np.pi*t)
s1 = np.sin(4*np.pi*t)
s2 = np.sin(6*np.pi*t)

fig, ax = plt.subplots()
l0, = ax.plot(t, s0, visible=False, lw=2)
l1, = ax.plot(t, s1, lw=2)
l2, = ax.plot(t, s2, lw=2)
plt.subplots_adjust(left=0.2)

rax = plt.axes([0.05, 0.4, 0.1, 0.15])
check = CheckButtons(rax, ('2 Hz', '4 Hz', '6 Hz'), (False, True, True))

def func(label):
    status = check.get_status()

    l0.set_visible(status[0])
    l1.set_visible(status[1])
    l2.set_visible(status[2])

    print status
    plt.draw()

check.on_clicked(func)

plt.show()

I also fixed a typo in the CheckButtons docstring that referred to them as "radio button".

[QuLogic]

• space after comma.

[DanHickstein]

@QuLogic: sure! Comma added!

[WeatherGod]

Needs unit test, and an update to whats_new.rst.

On Wed, Feb 17, 2016 at 7:44 PM, Danhickstein notifications@github.com
wrote:

@QuLogic https://github.com/QuLogic: sure! Comma added!

—
Reply to this email directly or view it on GitHub
#6018 (comment)
.

[tacaswell]

Please create a new file in the whats_new folder, not editing the main rst file (it helps keep merge confilcts down). The readme in that folder has a template.

[DanHickstein]

@tacaswell @WeatherGod, sounds good! I'll get to work on that.

[DanHickstein]

Okay, I added a file to doc/users/whats_new/ describing the new function, and I included a test_CheckButtons() unit test at the end of test_widgets.py. I couldn't see any other test of the CheckButtons, so I tried to test some of the other methods as well.

I couldn't figure out how to use the do_event() function (defined near the top of test_widgets.py) to simulate a user clicking on the check button, although I assume that I should be able to do this.

[DanHickstein]

Hmmm, I don't really understand why the TravisCI tests are failing. It seems to have to do with some colorbar plot comparisons. I don't think that I should have caused any problems with these. Should I worry about this?

[WeatherGod]

No, there was a problem commit that got merged into master last week that caused problems. I closed/reopened your PR to force a re-run of the CI's.

[WeatherGod]

Note, we haven't figured out how to force Appveyor to redo their runs, so ignore that for now.

[DanHickstein]

Thanks!

[DanHickstein]

I cleaned up the code to conform to pep8, and now it passes that test.

The Travis Python 2.7 test is still failing. It's one of the font tests, so it seems unrelated to these changes.

[DanHickstein]

Oh, it looks like Travis and Appveyor are building just fine now. Anything else that you would like me to add to this PR?

[WeatherGod]

Looks fine to me. Could probably spruce up the unit test a bit, but we can leave that as a future task.