/*
 * java-gnome, a UI library for writing GTK and GNOME programs from Java!
 *
 * Copyright © 2007-2010 Operational Dynamics Consulting, Pty Ltd and Others
 *
 * The code in this file, and the program it is a part of, is made available
 * to you by its authors as open source software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License version
 * 2 ("GPL") as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GPL for more details.
 *
 * You should have received a copy of the GPL along with this program. If not,
 * see http://www.gnu.org/licenses/. The authors of this program may be
 * contacted through http://java-gnome.sourceforge.net/.
 *
 * Linking this library statically or dynamically with other modules is making
 * a combined work based on this library. Thus, the terms and conditions of
 * the GPL cover the whole combination. As a special exception (the
 * "Classpath Exception"), the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent modules,
 * and to copy and distribute the resulting executable under terms of your
 * choice, provided that you also meet, for each linked independent module,
 * the terms and conditions of the license of that module. An independent
 * module is a module which is not derived from or based on this library. If
 * you modify this library, you may extend the Classpath Exception to your
 * version of the library, but you are not obligated to do so. If you do not
 * wish to do so, delete this exception statement from your version.
 */
package org.gnome.gtk;

/**
 * A toggle button widget that consists of a Check box and a Text box.
 * 
 * <p>
 * CheckButtons are similar to ToggleButtons, but look very different.
 * Contrary to ToggleButtons, which are Buttons with text inside them, they
 * are small check squares, with descriptive text beside them. As with
 * ToggleButtons, they can be used to toggle options on or off.
 * 
 * <p>
 * CheckButtons derive from ToggleButtons and hence behave somewhat similarly.
 * See in particular the {@link ToggleButton.TOGGLED TOGGLED} Signal inherited
 * from ToggleButton to detect changes in state to the CheckButton.
 * 
 * <p>
 * The choice between a CheckButton and a {@link ToggleButton} is left to the
 * developer's discretion. A CheckButton can take considerably lesser space
 * than a ToggleButton. A CheckButton is more useful when you have a list of
 * related options that need to be set or unset. A ToggleButton could be used
 * when a single option needs to be toggled.
 * 
 * @author Sebastian Mancke
 * @author Andrew Cowie
 * @author Srichand Pendyala
 * @since 4.0.3
 */
public class CheckButton extends ToggleButton
{
    protected CheckButton(long pointer) {
        super(pointer);
    }

    /**
     * Construct a new CheckButton.
     */
    public CheckButton() {
        super(GtkCheckButton.createCheckButton());
    }

    /**
     * Construct a new CheckButton containing a label with the given text. If
     * the text contains an underscore (the
     * <code>_<code> character) it will be taken to be the
     * mnemonic for the Widget.
     */
    public CheckButton(String label) {
        super(GtkCheckButton.createCheckButtonWithMnemonic(label));
    }
}
