Back to index

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

nsIFormControlFrame is the common interface for frames of form controls. More...

#include <nsIFormControlFrame.h>

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

List of all members.

Public Member Functions

 NS_IMETHOD_ (PRInt32) GetFormControlType() const =0
NS_IMETHOD GetName (nsAString *aName)=0
virtual void SetFocus (PRBool aOn=PR_TRUE, PRBool aRepaint=PR_FALSE)=0
virtual void ScrollIntoView (nsPresContext *aPresContext)=0
NS_IMETHOD SetSuggestedSize (nscoord aWidth, nscoord aHeight)=0
 Set the suggested size for the form element.
NS_IMETHOD GetFormContent (nsIContent *&aContent) const =0
 Get the content object associated with this frame.
NS_IMETHOD SetProperty (nsPresContext *aPresContext, nsIAtom *aName, const nsAString &aValue)=0
 Set a property on the form control frame.
NS_IMETHOD GetProperty (nsIAtom *aName, nsAString &aValue)=0
 Get a property from the form control frame.
NS_IMETHOD OnContentReset ()=0
 Notification that the content has been reset.

Detailed Description

nsIFormControlFrame is the common interface for frames of form controls.

It provides a uniform way of creating widgets, resizing, and painting.

See also:
nsLeafFrame and its base classes for more info

Definition at line 59 of file nsIFormControlFrame.h.


Member Function Documentation

NS_IMETHOD nsIFormControlFrame::GetFormContent ( nsIContent *&  aContent) const [pure virtual]

Get the content object associated with this frame.

Adds a reference to the content object so the caller must do a release.

See also:
nsISupports::Release()

Implemented in nsFormControlFrame, nsComboboxControlFrame, nsTextControlFrame, nsListControlFrame, nsHTMLButtonControlFrame, nsImageControlFrame, and nsFileControlFrame.

NS_IMETHOD nsIFormControlFrame::GetName ( nsAString *  aName) [pure virtual]
NS_IMETHOD nsIFormControlFrame::GetProperty ( nsIAtom aName,
nsAString &  aValue 
) [pure virtual]

Get a property from the form control frame.

Parameters:
aNamename of the property to get
aValuevalue of the property
Returns:
NS_OK if the property name is valid, otherwise an error code

Implemented in nsFormControlFrame, nsComboboxControlFrame, nsTextControlFrame, nsHTMLButtonControlFrame, nsListControlFrame, nsImageControlFrame, and nsFileControlFrame.

Here is the caller graph for this function:

nsIFormControlFrame::NS_IMETHOD_ ( PRInt32  ) const [pure virtual]

Notification that the content has been reset.

Implemented in nsComboboxControlFrame, nsTextControlFrame, nsListControlFrame, nsHTMLButtonControlFrame, nsImageControlFrame, nsGfxRadioControlFrame, nsGfxCheckboxControlFrame, and nsFileControlFrame.

Here is the caller graph for this function:

virtual void nsIFormControlFrame::ScrollIntoView ( nsPresContext aPresContext) [pure virtual]
virtual void nsIFormControlFrame::SetFocus ( PRBool  aOn = PR_TRUE,
PRBool  aRepaint = PR_FALSE 
) [pure virtual]
NS_IMETHOD nsIFormControlFrame::SetProperty ( nsPresContext aPresContext,
nsIAtom aName,
const nsAString &  aValue 
) [pure virtual]

Set a property on the form control frame.

Parameters:
aNamename of the property to set
aValuevalue of the property
Returns:
NS_OK if the property name is valid, otherwise an error code

Implemented in nsFormControlFrame, nsComboboxControlFrame, nsTextControlFrame, nsHTMLButtonControlFrame, nsListControlFrame, nsImageControlFrame, and nsFileControlFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIFormControlFrame::SetSuggestedSize ( nscoord  aWidth,
nscoord  aHeight 
) [pure virtual]

Set the suggested size for the form element.

This is used to control the size of the element during reflow if it hasn't had it's size explicitly set.

Parameters:
aWidthwidth of the form element
aHeightheight of the form element
Returns:
NS_OK

Implemented in nsFormControlFrame, nsListControlFrame, nsTextControlFrame, nsComboboxControlFrame, nsHTMLButtonControlFrame, nsImageControlFrame, nsFileControlFrame, and nsGfxButtonControlFrame.


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