layout/forms/nsIFormControlFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   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  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIFormControlFrame_h___
  39 #define nsIFormControlFrame_h___
  40
  41 #include "nsQueryFrame.h"
  42 class nsAString;
  43 class nsIContent;
  44 class nsIAtom;
  45 struct nsSize;
  46
  47 /**
  48   * nsIFormControlFrame is the common interface for frames of form controls. It
  49   * provides a uniform way of creating widgets, resizing, and painting.
  50   * @see nsLeafFrame and its base classes for more info
  51   */
  52 class nsIFormControlFrame : public nsQueryFrame
  53 {
  54 public:
  55   NS_DECL_QUERYFRAME_TARGET(nsIFormControlFrame)
  56
  57   /**
  58    *
  59    * @param aOn
  60    * @param aRepaint
  61    */
  62   virtual void SetFocus(PRBool aOn = PR_TRUE, PRBool aRepaint = PR_FALSE) = 0;
  63
  64   /**
  65    * Set a property on the form control frame.
  66    *
  67    * @param aName name of the property to set
  68    * @param aValue value of the property
  69    * @returns NS_OK if the property name is valid, otherwise an error code
  70    */
  71   virtual nsresult SetFormProperty(nsIAtom* aName, const nsAString& aValue) = 0;
  72
  73   /**
  74    * Get a property from the form control frame
  75    *
  76    * @param aName name of the property to get.
  77    * @param aValue Value to set.
  78    * @returns NS_OK if the property name is valid, otherwise an error code.
  79    */
  80
  81   virtual nsresult GetFormProperty(nsIAtom* aName, nsAString& aValue) const = 0;
  82 };
  83
  84 #endif
  85