Mozilla/mozilla/layout/html/forms/src/nsInput.h

/* -*- Mode: C++; tab-width: 2; 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 nsInput_h___
#define nsInput_h___

#include "nsHTMLContainer.h"
#include "nsIFormControl.h"
#include "nsPoint.h"
class nsIFormManager;
class nsIWidget;
class nsIView;
class nsIPresContext;


/**
  * nsInput represents an html Input element. This is a base class for
  * the various Input types (button, checkbox, file, hidden, password,
  * reset, radio, submit, text)
  */
class nsInput : public nsHTMLContainer {
public:
  typedef nsHTMLContainer nsInputSuper;
  /** 
    * main constructor
    * @param aTag the html tag associated with this object
    * @param aManager the form manager to manage this input
    */
  nsInput(nsIAtom* aTag, nsIFormManager* aManager);

  /**
    * @see nsIContentDelegate CreateFrame
    */
  virtual nsresult CreateFrame(nsIPresContext*  aPresContext,
                               nsIFrame*        aParentFrame,
                               nsIStyleContext* aStyleContext,
                               nsIFrame*&       aResult) = 0;

  virtual void MapAttributesInto(nsIStyleContext* aContext, 
                                 nsIPresContext* aPresContext);
  /**
    * @see nsISupports QueryInterface
    */
  NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr);

  /**
    * @see nsISupports Release
    */
  NS_IMETHOD_(nsrefcnt) Release(void);

  // nsIFormControl methods

  virtual PRBool GetCanSubmit() const;

  virtual PRBool GetContent(nsString& aResult) const;

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual nsIFormManager* GetFormManager() const;

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual PRInt32 GetMaxNumValues();

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual PRBool GetName(nsString& aName) const;

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual PRBool GetNamesValues(PRInt32 aMaxNumValues, PRInt32& aNumValues,
                                nsString* aValues, nsString* aNames);

  virtual PRBool IsHidden();

  virtual PRBool IsSuccessful(nsIFormControl* aSubmitter) const;

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual void Reset();

  virtual void SetCanSubmit(PRBool aFlag);

  virtual void SetContent(const nsString& aValue);

  /**
    * @see nsIFormControl GetFormManager
    */
  virtual void SetFormManager(nsIFormManager* aFormMan, PRBool aDecrementRef = PR_TRUE);

  // attribute methods

  /**
    * Get a named attribute of this input
    * @param aAttribute the name of the attribute
    * @param aValue the value of the attribute
    * @return eContentAttr_HasValue if there is a value, eContentAttr_NoValue
    * if there is an attribute but no value, or eContentAttr_HasValue
    * if there is no attribute.
    */
  virtual nsContentAttr GetAttribute(nsIAtom* aAttribute,
                                     nsHTMLValue& aValue) const;

  virtual nsContentAttr GetAttribute(nsIAtom* aAttribute, nsString& aValue) const;
  virtual nsContentAttr GetAttribute(nsIAtom* aAttribute, PRInt32& aValue) const;
 
  /**
    * Set the named attribute of this input
    * @param aAttribute the name of the attribute
    * @param aValue the value of the attribute
    */
  virtual void SetAttribute(nsIAtom* aAttribute, const nsString& aValue);


  // misc methods

  /**
    * Get the number of references to this input
    * @return the number of references
   **/
  virtual nsrefcnt GetRefCount() const;

  /**
    * Get the widget associated with this input
    * @return the widget, not a copy
   **/
  nsIWidget*   GetWidget();
  nsISupports* GetWidgetSupports();

  /**
    * Set the widget associated with this input
    * @param aWidget the widget
   **/
  void SetWidget(nsIWidget* aWidget);

  // this should not be public
  static PRInt32 GetOuterOffset() {
    return offsetof(nsInput,mControl);
  }

  virtual void GetType(nsString& aResult) const = 0;
  PRInt32 GetSize() const { return mSize; }
  virtual PRBool GetChecked(PRBool aGetInitialValue) const;
  virtual void SetChecked(PRBool aState, PRBool aSetInitialValue);
  virtual void SetClickPoint(nscoord aX, nscoord aY);

protected:
  virtual         ~nsInput();

  /**
    * Get the type of this control
    */
  nsIWidget*      mWidget;
  nsISupports*    mWidgetSupports;
  nsIFormManager* mFormMan;
  nsPoint         mLastClickPoint;
  PRBool          mCanSubmit;

  void          CacheAttribute(const nsString& aValue, nsString*& aLoc);
  void          CacheAttribute(const nsString& aValue, PRInt32 aMinValue, PRInt32& aLoc);
  nsContentAttr GetCacheAttribute(nsString* const& aLoc, nsHTMLValue& aValue) const;
  nsContentAttr GetCacheAttribute(PRInt32 aLoc, nsHTMLValue& aValue, nsHTMLUnit aUnit) const;

  // Attributes common to all html form elements
  nsString*       mName;
  nsString*       mValue;
  PRInt32         mSize;
  PRUint8         mAlign;

  // Aggregator class and instance variable used to aggregate in the
  // nsIFormControl interface to nsInput w/o using multiple
  // inheritance.
  class AggInputControl : public nsIFormControl {
  public:
    AggInputControl();
    ~AggInputControl();

    // nsISupports
    NS_DECL_ISUPPORTS

    // nsIFormControl
    virtual PRBool GetCanSubmit() const;
    virtual PRBool GetContent(nsString& aResult) const;
    virtual PRBool GetName(nsString& aName) const;
    virtual void GetType(nsString& aType) const;
    virtual PRInt32 GetMaxNumValues();
    virtual PRBool GetNamesValues(PRInt32 aMaxNumValues, PRInt32& aNumValues,
                                  nsString* aValues, nsString* aNames);
    virtual void Reset();
    virtual void SetCanSubmit(PRBool aFlag);
    virtual void SetContent(const nsString& aValue);
    virtual void SetFormManager(nsIFormManager* aFormMan, PRBool aDecrementRef = PR_TRUE);
    virtual nsIFormManager* GetFormManager() const;
    virtual nsrefcnt GetRefCount() const;
    virtual PRBool GetChecked(PRBool aGetInitialValue) const;
    virtual void SetChecked(PRBool aState, PRBool aSetInitialValue);
    virtual PRBool IsSuccessful(nsIFormControl* aSubmitter) const;
  };
  AggInputControl mControl;
};

#endif