layout/style/nsDOMCSSValueList.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Christopher A. Aillon <christopher@aillon.com> (original author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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 /* DOM object representing lists of values in DOM computed style */
  39
  40 #ifndef nsDOMCSSValueList_h___
  41 #define nsDOMCSSValueList_h___
  42
  43 #include "nsIDOMCSSValue.h"
  44 #include "nsIDOMCSSValueList.h"
  45 #include "nsCOMArray.h"
  46
  47 #include "nsCOMPtr.h"
  48
  49 class nsDOMCSSValueList : public nsIDOMCSSValueList
  50 {
  51 public:
  52   NS_DECL_ISUPPORTS
  53
  54   // nsIDOMCSSValueList
  55   NS_DECL_NSIDOMCSSVALUELIST
  56
  57   // nsIDOMCSSValue
  58   NS_DECL_NSIDOMCSSVALUE
  59
  60   // nsDOMCSSValueList
  61   nsDOMCSSValueList(PRBool aCommaDelimited, PRBool aReadonly);
  62   virtual ~nsDOMCSSValueList();
  63
  64   /**
  65    * Adds a value to this list.
  66    * @retval PR_TRUE Adding the value succeeded
  67    * @retval PR_FALSE The value could not be added (Out of memory)
  68    */
  69   PRBool AppendCSSValue(nsIDOMCSSValue* aValue);
  70
  71   nsIDOMCSSValue* GetItemAt(PRUint32 aIndex)
  72   {
  73     return mCSSValues.SafeObjectAt(aIndex);
  74   }
  75
  76   static nsDOMCSSValueList* FromSupports(nsISupports* aSupports)
  77   {
  78 #ifdef DEBUG
  79     {
  80       nsCOMPtr<nsIDOMCSSValueList> list_qi = do_QueryInterface(aSupports);
  81
  82       // If this assertion fires the QI implementation for the object in
  83       // question doesn't use the nsIDOMCSSValueList pointer as the nsISupports
  84       // pointer. That must be fixed, or we'll crash...
  85       NS_ASSERTION(list_qi == static_cast<nsIDOMCSSValueList*>(aSupports),
  86                    "Uh, fix QI!");
  87     }
  88 #endif
  89
  90     return static_cast<nsDOMCSSValueList*>(aSupports);
  91   }
  92
  93 private:
  94   PRPackedBool                mCommaDelimited;  // some value lists use a comma
  95                                                 // as the delimiter, some just use
  96                                                 // spaces.
  97
  98   PRPackedBool                mReadonly;    // Are we read-only?
  99
 100   nsCOMArray<nsIDOMCSSValue>  mCSSValues;
 101 };
 102
 103
 104 #endif /* nsDOMCSSValueList_h___ */