Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIRadioGroupContainer Class Reference

A container that has multiple radio groups in it, defined by name. More...

#include <nsIRadioGroupContainer.h>

Inheritance diagram for nsIRadioGroupContainer:
Inheritance graph
[legend]
Collaboration diagram for nsIRadioGroupContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD WalkRadioGroup (const nsAString &aName, nsIRadioVisitor *aVisitor)=0
 Walk through the radio group, visiting each note with avisitor->Visit()
NS_IMETHOD SetCurrentRadioButton (const nsAString &aName, nsIDOMHTMLInputElement *aRadio)=0
 Set the current radio button in a group.
NS_IMETHOD GetCurrentRadioButton (const nsAString &aName, nsIDOMHTMLInputElement **aRadio)=0
 Get the current radio button in a group.
NS_IMETHOD GetNextRadioButton (const nsAString &aName, const PRBool aPrevious, nsIDOMHTMLInputElement *aFocusedRadio, nsIDOMHTMLInputElement **aRadio)=0
 Get the next/prev radio button in a group.
NS_IMETHOD AddToRadioGroup (const nsAString &aName, nsIFormControl *aRadio)=0
 Add radio button to radio group.
NS_IMETHOD RemoveFromRadioGroup (const nsAString &aName, nsIFormControl *aRadio)=0
 Remove radio button from radio group.
NS_IMETHOD GetPositionInGroup (nsIDOMHTMLInputElement *aRadio, PRInt32 *aPositionIndex, PRInt32 *aItemsInGroup)=0
 Get the radio group position and the number of radio buttons in the group.

Detailed Description

A container that has multiple radio groups in it, defined by name.

Definition at line 54 of file nsIRadioGroupContainer.h.


Member Function Documentation

NS_IMETHOD nsIRadioGroupContainer::AddToRadioGroup ( const nsAString &  aName,
nsIFormControl aRadio 
) [pure virtual]

Add radio button to radio group.

Note that forms do not do anything for this method since they already store radio groups on their own.

Parameters:
aNameradio group's name
aRadioradio button's pointer

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::GetCurrentRadioButton ( const nsAString &  aName,
nsIDOMHTMLInputElement **  aRadio 
) [pure virtual]

Get the current radio button in a group.

Parameters:
aNamethe group name
aRadiothe currently selected radio button [OUT]

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::GetNextRadioButton ( const nsAString &  aName,
const PRBool  aPrevious,
nsIDOMHTMLInputElement aFocusedRadio,
nsIDOMHTMLInputElement **  aRadio 
) [pure virtual]

Get the next/prev radio button in a group.

Parameters:
aNamethe group name
aPrevious,truegets previous radio button, false gets next
aFocusedRadiothe currently focused radio button
aRadiothe currently selected radio button [OUT]

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::GetPositionInGroup ( nsIDOMHTMLInputElement aRadio,
PRInt32 aPositionIndex,
PRInt32 aItemsInGroup 
) [pure virtual]

Get the radio group position and the number of radio buttons in the group.

that the radio button is in. If the radio button not grouped with any other radio buttons this method will treat it as being in a group of one.

Parameters:
aRadioradio button's pointer
aPositionIndexout indicates 0-indexed position in the radio group, or just 0 if a group cannot be found
aItemsInGroupthe number of radio buttons in the group

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::RemoveFromRadioGroup ( const nsAString &  aName,
nsIFormControl aRadio 
) [pure virtual]

Remove radio button from radio group.

Note that forms do not do anything for this method since they already store radio groups on their own.

Parameters:
aNameradio group's name
aRadioradio button's pointer

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::SetCurrentRadioButton ( const nsAString &  aName,
nsIDOMHTMLInputElement aRadio 
) [pure virtual]

Set the current radio button in a group.

Parameters:
aNamethe group name
aRadiothe currently selected radio button

Implemented in nsDocument, and nsHTMLFormElement.

NS_IMETHOD nsIRadioGroupContainer::WalkRadioGroup ( const nsAString &  aName,
nsIRadioVisitor aVisitor 
) [pure virtual]

Walk through the radio group, visiting each note with avisitor->Visit()

Parameters:
aNamethe group name
aVisitorthe visitor to visit with

Implemented in nsDocument, and nsHTMLFormElement.


The documentation for this class was generated from the following file: