gecko-dev/widget/public/nsIRadioButton.h

82 lines
2.2 KiB
C
Raw Normal View History

1998-04-13 20:24:54 +00:00
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#ifndef nsIRadioButton_h__
#define nsIRadioButton_h__
#include "nsIButton.h"
#define NS_IRADIOBUTTON_IID \
{ 0x18032ad4, 0xb265, 0x11d2, \
{ 0xaa, 0x2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
class nsIRadioGroup;
/**
* RadioButton widget.
* Can show itself in a checked or unchecked state.
* The RadioButton widget does automatically show itself checked or unchecked when clicked on.
*/
class nsIRadioButton : public nsIButton {
public:
/**
* Set the radio state.
* @param PRBool PR_TRUE sets the RadioButton and unsets all siblings, PR_FALSE unsets it
*
*/
virtual void SetState(PRBool aState) = 0;
/**
* Tells the RadioButton NOT to notify the RadioGroup that it value has been changed
*
* @param PRBool PR_TRUE sets the RadioButton and unsets all siblings, PR_FALSE unsets it
*
*/
virtual void SetStateNoNotify(PRBool aState) = 0;
/**
* Gets the state the RadioButton
*
* @return BRBool PR_TRUE if set, PR_FALSE if unset
*
*/
virtual PRBool GetState() = 0;
/**
* Gets the RadioGroup associated with this button
*
* @return nsIRadioGroup* its RadioGroup
*
*/
virtual nsIRadioGroup* GetRadioGroup() = 0;
/**
* Sets the RadioGroup associated with this button
*
* @param nsIRadioGroup* the new RadioGroup
*
*/
virtual void SetRadioGroup(nsIRadioGroup* aGroup) = 0;
};
#endif // nsIRadioButton_h__