LCOV - code coverage report
Current view: directory - layout/generic - nsIAnonymousContentCreator.h (source / functions) Found Hit Coverage
Test: app.info Lines: 9 0 0.0 %
Date: 2012-06-02 Functions: 6 0 0.0 %

       1                 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
       2                 : /* ***** BEGIN LICENSE BLOCK *****
       3                 :  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
       4                 :  *
       5                 :  * The contents of this file are subject to the Mozilla Public License Version
       6                 :  * 1.1 (the "License"); you may not use this file except in compliance with
       7                 :  * the License. You may obtain a copy of the License at
       8                 :  * http://www.mozilla.org/MPL/
       9                 :  *
      10                 :  * Software distributed under the License is distributed on an "AS IS" basis,
      11                 :  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
      12                 :  * for the specific language governing rights and limitations under the
      13                 :  * License.
      14                 :  *
      15                 :  * The Original Code is mozilla.org code.
      16                 :  *
      17                 :  * The Initial Developer of the Original Code is
      18                 :  * Netscape Communications Corporation.
      19                 :  * Portions created by the Initial Developer are Copyright (C) 1998
      20                 :  * the Initial Developer. All Rights Reserved.
      21                 :  *
      22                 :  * Contributor(s):
      23                 :  *
      24                 :  * Alternatively, the contents of this file may be used under the terms of
      25                 :  * either of the GNU General Public License Version 2 or later (the "GPL"),
      26                 :  * or 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                 : /*
      39                 :  * interface for rendering objects that manually create subtrees of
      40                 :  * anonymous content
      41                 :  */
      42                 : 
      43                 : #ifndef nsIAnonymousContentCreator_h___
      44                 : #define nsIAnonymousContentCreator_h___
      45                 : 
      46                 : #include "nsQueryFrame.h"
      47                 : #include "nsIContent.h"
      48                 : #include "nsStyleContext.h"
      49                 : 
      50                 : class nsBaseContentList;
      51                 : class nsIFrame;
      52                 : template <class T, class A> class nsTArray;
      53                 : 
      54                 : /**
      55                 :  * Any source for anonymous content can implement this interface to provide it.
      56                 :  * HTML frames like nsFileControlFrame currently use this.
      57                 :  *
      58                 :  * @see nsCSSFrameConstructor
      59                 :  */
      60                 : class nsIAnonymousContentCreator
      61               0 : {
      62                 : public:
      63                 :   NS_DECL_QUERYFRAME_TARGET(nsIAnonymousContentCreator)
      64                 : 
      65               0 :   struct ContentInfo {
      66               0 :     ContentInfo(nsIContent* aContent) :
      67               0 :       mContent(aContent)
      68               0 :     {}
      69                 : 
      70               0 :     ContentInfo(nsIContent* aContent, nsStyleContext* aStyleContext) :
      71               0 :       mContent(aContent), mStyleContext(aStyleContext)
      72               0 :     {}
      73                 : 
      74                 :     nsIContent* mContent;
      75                 :     nsRefPtr<nsStyleContext> mStyleContext;
      76                 :   };
      77                 : 
      78                 :   /**
      79                 :    * Creates "native" anonymous content and adds the created content to
      80                 :    * the aElements array. None of the returned elements can be nsnull.
      81                 :    *
      82                 :    * @note The returned elements are owned by this object. This object is
      83                 :    *       responsible for calling UnbindFromTree on the elements it returned
      84                 :    *       from CreateAnonymousContent when appropriate (i.e. before releasing
      85                 :    *       them).
      86                 :    */
      87                 :   virtual nsresult CreateAnonymousContent(nsTArray<ContentInfo>& aElements)=0;
      88                 : 
      89                 :   /**
      90                 :    * Appends "native" anonymous children created by CreateAnonymousContent()
      91                 :    * to the given content list depending on the filter.
      92                 :    *
      93                 :    * @see nsIContent::GetChildren for set of values used for filter.
      94                 :    */
      95                 :   virtual void AppendAnonymousContentTo(nsBaseContentList& aElements,
      96                 :                                         PRUint32 aFilter) = 0;
      97                 : 
      98                 :   /**
      99                 :    * Implementations can override this method to create special frames for the
     100                 :    * anonymous content returned from CreateAnonymousContent.
     101                 :    * By default this method returns nsnull, which means the default frame
     102                 :    * is created.
     103                 :    */
     104               0 :   virtual nsIFrame* CreateFrameFor(nsIContent* aContent) { return nsnull; }
     105                 : };
     106                 : 
     107                 : #endif
     108                 : 

Generated by: LCOV version 1.7