layout/forms/nsIFormControlFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsIFormControlFrame_h___
   7 #define nsIFormControlFrame_h___
   8
   9 #include "nsQueryFrame.h"
  10 class nsAString;
  11 class nsIContent;
  12 class nsIAtom;
  13 struct nsSize;
  14
  15 /**
  16   * nsIFormControlFrame is the common interface for frames of form controls. It
  17   * provides a uniform way of creating widgets, resizing, and painting.
  18   * @see nsLeafFrame and its base classes for more info
  19   */
  20 class nsIFormControlFrame : public nsQueryFrame
  21 {
  22 public:
  23   NS_DECL_QUERYFRAME_TARGET(nsIFormControlFrame)
  24
  25   /**
  26    *
  27    * @param aOn
  28    * @param aRepaint
  29    */
  30   virtual void SetFocus(bool aOn = true, bool aRepaint = false) = 0;
  31
  32   /**
  33    * Set a property on the form control frame.
  34    *
  35    * @param aName name of the property to set
  36    * @param aValue value of the property
  37    * @returns NS_OK if the property name is valid, otherwise an error code
  38    */
  39   virtual nsresult SetFormProperty(nsIAtom* aName, const nsAString& aValue) = 0;
  40 };
  41
  42 #endif
  43