sbImageLabelLinkPropertyInfo Class Reference

#include <sbImageLabelLinkPropertyInfo.h>

Inheritance diagram for sbImageLabelLinkPropertyInfo:
Collaboration diagram for sbImageLabelLinkPropertyInfo:

Public Types

typedef nsClassHashtable
< nsCStringHashKey, nsCString > 
typedef nsClassHashtable
< nsCStringHashKey, nsString > 
typedef nsTHashtable
< nsISupportsHashKey > 

Public Member Functions

 sbImageLabelLinkPropertyInfo ()
virtual ~sbImageLabelLinkPropertyInfo ()
nsresult Init ()
nsresult Init (ImageMap_t *&aImages, LabelMap_t *&aLabels, InterfaceSet_t *&aClickHandlers)
NS_IMETHOD SetPropertyID (const nsAString &aPropertyID)
NS_IMETHOD SetDisplayName (const nsAString &aDisplayName)
NS_IMETHOD SetLocalizationKey (const nsAString &aLocalizationKey)
NS_IMETHOD SetRemoteReadable (PRBool aRemoteReadable)
NS_IMETHOD SetRemoteWritable (PRBool aRemoteWritable)
NS_IMETHOD SetUserViewable (PRBool aUserViewable)
NS_IMETHOD SetUserEditable (PRBool aUserEditable)
NS_IMETHOD SetUrlPropertyID (const nsAString &aUrlPropertyID)
NS_IMETHOD GetImageSrc (const nsAString &aValue, nsAString &_retval)
NS_IMETHOD GetCellProperties (const nsAString &aValue, nsAString &_retval)
NS_IMETHOD HitTest (const nsAString &aCurrentValue, const nsAString &aPart, PRUint32 aBoxWidth, PRUint32 aBoxHeight, PRUint32 aMouseX, PRUint32 aMouseY, PRBool *_retval)
NS_IMETHOD OnClick (sbIMediaItem *aItem, nsISupports *aEvent, nsISupports *aContext, PRBool *_retval)
NS_IMETHOD Format (const nsAString &aValue, nsAString &_retval)
- Public Member Functions inherited from sbImmutablePropertyInfo
sbImmutablePropertyInfo ()
virtual ~sbImmutablePropertyInfo ()
NS_IMETHOD SetUnitConverter (sbIPropertyUnitConverter *aUnitConverter)
- Public Member Functions inherited from sbIPropertyInfo
sbIPropertyOperator getOperator (in AString aOperator)
 Get the sbIPropertyOperator for the given operator string. More...
boolean validate (in AString aValue)
 Validates the string for this property type. More...
AString sanitize (in AString aValue)
 Sanitize a value so that it passes validation. More...
AString format (in AString aValue)
 Formats the value for display. More...
AString makeSortable (in AString aValue)
 Transforms the string into its sortable collation data equivalent. More...
AString makeSearchable (in AString aValue)
 Formats the value to enable proper search. More...
- Public Member Functions inherited from sbSupportsWeakReference
 sbSupportsWeakReference ()
- Public Member Functions inherited from sbIClickablePropertyInfo
boolean isDisabled (in AString aCurrentValue)
 Whether the tree cell widget representing this property should be disabled given a value (for this property) More...
boolean hitTest (in AString aCurrentValue, in AString aPart, in unsigned long aBoxWidth, in unsigned long aBoxHeight, in unsigned long aMouseX, in unsigned long aMouseY)
 Hit testing for a cell. More...
boolean onClick (in sbIMediaItem aItem, [optional] in nsISupports aEvent, [optional] in nsISupports aContext)
 Callback for a click event for special handling. More...
AString getValueForClick (in AString aCurrentValue, in unsigned long aBoxWidth, in unsigned long aBoxHeight, in unsigned long aMouseX, in unsigned long aMouseY)
 Convert a mouse click to a value for this property. More...
- Public Member Functions inherited from sbITreeViewPropertyInfo
AString getImageSrc (in AString aValue)
long getProgressMode (in AString aValue)
AString getCellValue (in AString aValue)
AString getRowProperties (in AString aValue)
AString getCellProperties (in AString aValue)

Additional Inherited Members

- Public Attributes inherited from sbIPropertyInfo
readonly attribute AString OPERATOR_EQUALS
readonly attribute AString OPERATOR_NOTEQUALS
readonly attribute AString OPERATOR_GREATER
readonly attribute AString OPERATOR_GREATEREQUAL
readonly attribute AString OPERATOR_LESS
readonly attribute AString OPERATOR_LESSEQUAL
readonly attribute AString OPERATOR_CONTAINS
readonly attribute AString OPERATOR_NOTCONTAINS
readonly attribute AString OPERATOR_BEGINSWITH
readonly attribute AString OPERATOR_NOTBEGINSWITH
readonly attribute AString OPERATOR_ENDSWITH
readonly attribute AString OPERATOR_NOTENDSWITH
readonly attribute AString OPERATOR_BETWEEN
readonly attribute AString OPERATOR_ISSET
readonly attribute AString OPERATOR_ISNOTSET
const unsigned long SORT_NULL_SMALL = 0
 Causes null values to be infinitely small. This is the default. More...
const unsigned long SORT_NULL_BIG = 1
 Causes null values to be infinitely large. More...
const unsigned long SORT_NULL_FIRST = 2
 Null values always first. More...
const unsigned long SORT_NULL_LAST = 3
 Null values always last. More...
attribute unsigned long nullSort
 Set where NULL values get sorted to. More...
attribute sbIPropertyArray secondarySort
 When sorting by this property, additionally sort by the following properties. More...
attribute AString id
 Unique ID for this property. More...
attribute AString type
 The type property. More...
attribute AString displayName
 Localized display name of this property. More...
attribute AString localizationKey
 Key used to find related localization strings. More...
attribute boolean userViewable
 A user may view this property. This does not impede reading the value, it's merely meant as a guideline. More...
attribute boolean userEditable
 A user may edit this property. This does not impede editing the value, it's merely meant as a guideline. More...
attribute boolean remoteReadable
 A web site may read the value of this property. More...
attribute boolean remoteWritable
 A web site may write the value of this property. More...
attribute boolean usedInIdentity
 This attribute indicates that changing this property may change the computed hash for the item. If a property with usedInIdentity of true is changed, the identity is recalculated. More...
attribute nsISimpleEnumerator operators
 True if this property has a selection list. More...
readonly attribute
 A unit converter to convert to and from the units in which the property can be expressed. More...
- Public Attributes inherited from sbIClickablePropertyInfo
attribute boolean suppressSelect
- Public Attributes inherited from sbITreeViewPropertyInfo
readonly attribute AString columnType
- Protected Member Functions inherited from sbImmutablePropertyInfo
nsresult Init ()
- Protected Member Functions inherited from sbSupportsWeakReference
 ~sbSupportsWeakReference ()
void ClearWeakReferences ()
PRBool HasWeakReferences () const
- Protected Attributes inherited from sbImmutablePropertyInfo
PRUint32 mNullSort
nsCOMPtr< sbIPropertyArraymSecondarySort
nsString mID
nsString mType
nsString mDisplayName
nsString mLocalizationKey
PRBool mUserViewable
PRBool mUserEditable
PRBool mRemoteReadable
PRBool mRemoteWritable
PRBool mUsedInIdentity
nsCOMPtr< nsIStringBundle > mBundle
PRLock * mOperatorsLock
nsCOMArray< sbIPropertyOperatormOperators
< sbIPropertyUnitConverter

Detailed Description

Definition at line 42 of file sbImageLabelLinkPropertyInfo.h.

Member Typedef Documentation

typedef nsClassHashtable<nsCStringHashKey, nsCString> sbImageLabelLinkPropertyInfo::ImageMap_t

Definition at line 50 of file sbImageLabelLinkPropertyInfo.h.

typedef nsTHashtable<nsISupportsHashKey> sbImageLabelLinkPropertyInfo::InterfaceSet_t

Definition at line 52 of file sbImageLabelLinkPropertyInfo.h.

typedef nsClassHashtable<nsCStringHashKey, nsString> sbImageLabelLinkPropertyInfo::LabelMap_t

Definition at line 51 of file sbImageLabelLinkPropertyInfo.h.

Constructor & Destructor Documentation

sbImageLabelLinkPropertyInfo::sbImageLabelLinkPropertyInfo ( )
sbImageLabelLinkPropertyInfo::~sbImageLabelLinkPropertyInfo ( )

Definition at line 58 of file sbImageLabelLinkPropertyInfo.cpp.

Member Function Documentation

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::Format ( const nsAString &  aValue,
nsAString &  _retval 

Definition at line 336 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::GetCellProperties ( const nsAString &  aValue,
nsAString &  _retval 

Definition at line 252 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::GetImageSrc ( const nsAString &  aValue,
nsAString &  _retval 

Definition at line 228 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::HitTest ( const nsAString &  aCurrentValue,
const nsAString &  aPart,
PRUint32  aBoxWidth,
PRUint32  aBoxHeight,
PRUint32  aMouseX,
PRUint32  aMouseY,
PRBool *  _retval 

Definition at line 267 of file sbImageLabelLinkPropertyInfo.cpp.

nsresult sbImageLabelLinkPropertyInfo::Init ( )

Definition at line 66 of file sbImageLabelLinkPropertyInfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

nsresult sbImageLabelLinkPropertyInfo::Init ( ImageMap_t *&  aImages,
LabelMap_t *&  aLabels,
InterfaceSet_t *&  aClickHandlers 

Definition at line 85 of file sbImageLabelLinkPropertyInfo.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::OnClick ( sbIMediaItem aItem,
nsISupports aEvent,
nsISupports aContext,
PRBool *  _retval 

Definition at line 282 of file sbImageLabelLinkPropertyInfo.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetDisplayName ( const nsAString &  aDisplayName)

Definition at line 110 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetLocalizationKey ( const nsAString &  aLocalizationKey)

Definition at line 117 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetPropertyID ( const nsAString &  aPropertyID)

Definition at line 103 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetRemoteReadable ( PRBool  aRemoteReadable)

Definition at line 124 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetRemoteWritable ( PRBool  aRemoteWritable)

Definition at line 131 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetUrlPropertyID ( const nsAString &  aUrlPropertyID)

Definition at line 152 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetUserEditable ( PRBool  aUserEditable)

Definition at line 145 of file sbImageLabelLinkPropertyInfo.cpp.

NS_IMETHODIMP sbImageLabelLinkPropertyInfo::SetUserViewable ( PRBool  aUserViewable)

Definition at line 138 of file sbImageLabelLinkPropertyInfo.cpp.

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