← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/content/html/content/public/nsIRadioGroupContainer.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/content/html/content/public/nsIRadioGroupContainer.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
#ifndef nsIRadioGroupContainer_h___
 
39
#define nsIRadioGroupContainer_h___
 
40
 
 
41
#include "nsISupports.h"
 
42
 
 
43
class nsIDOMHTMLInputElement;
 
44
class nsString;
 
45
class nsIRadioVisitor;
 
46
class nsIFormControl;
 
47
 
 
48
#define NS_IRADIOGROUPCONTAINER_IID   \
 
49
{ 0x06de7839, 0xd0db, 0x47d3, \
 
50
  { 0x82, 0x90, 0x3c, 0xb8, 0x62, 0x2e, 0xd9, 0x66 } }
 
51
 
 
52
/**
 
53
 * A container that has multiple radio groups in it, defined by name.
 
54
 */
 
55
class nsIRadioGroupContainer : public nsISupports
 
56
{
 
57
public:
 
58
 
 
59
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IRADIOGROUPCONTAINER_IID)
 
60
 
 
61
  /**
 
62
   * Walk through the radio group, visiting each note with avisitor->Visit()
 
63
   * @param aName the group name
 
64
   * @param aVisitor the visitor to visit with
 
65
   */
 
66
  NS_IMETHOD WalkRadioGroup(const nsAString& aName,
 
67
                            nsIRadioVisitor* aVisitor) = 0;
 
68
 
 
69
  /**
 
70
   * Set the current radio button in a group
 
71
   * @param aName the group name
 
72
   * @param aRadio the currently selected radio button
 
73
   */
 
74
  NS_IMETHOD SetCurrentRadioButton(const nsAString& aName,
 
75
                                   nsIDOMHTMLInputElement* aRadio) = 0;
 
76
 
 
77
  /**
 
78
   * Set the current radio button in a group
 
79
   * @param aName the group name
 
80
   * @param aRadio the currently selected radio button [OUT]
 
81
   */
 
82
  NS_IMETHOD GetCurrentRadioButton(const nsAString& aName,
 
83
                                   nsIDOMHTMLInputElement** aRadio) = 0;
 
84
 
 
85
  /**
 
86
   * Add radio button to radio group
 
87
   *
 
88
   * Note that forms do not do anything for this method since they already
 
89
   * store radio groups on their own.
 
90
   *
 
91
   * @param aName radio group's name
 
92
   * @param aRadio radio button's pointer
 
93
   */
 
94
  NS_IMETHOD AddToRadioGroup(const nsAString& aName,
 
95
                             nsIFormControl* aRadio) = 0;
 
96
 
 
97
  /**
 
98
   * Remove radio button from radio group
 
99
   *
 
100
   * Note that forms do not do anything for this method since they already
 
101
   * store radio groups on their own.
 
102
   *
 
103
   * @param aName radio group's name
 
104
   * @param aRadio radio button's pointer
 
105
   */
 
106
  NS_IMETHOD RemoveFromRadioGroup(const nsAString& aName,
 
107
                                  nsIFormControl* aRadio) = 0;
 
108
};
 
109
 
 
110
#endif /* nsIRadioGroupContainer_h__ */