Back to index

lightning-sunbird  0.9+nobinonly
nsIsIndexFrame.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsIsIndexFrame_h___
00039 #define nsIsIndexFrame_h___
00040 
00041 #include "nsAreaFrame.h"
00042 #include "nsIFormControlFrame.h"
00043 #include "nsIAnonymousContentCreator.h"
00044 #include "nsIStatefulFrame.h"
00045 #include "nsIUnicodeEncoder.h"
00046 #include "nsIDOMKeyListener.h"
00047 
00048 #include "nsTextControlFrame.h"
00049 #include "nsFormControlHelper.h"
00050 typedef   nsTextControlFrame nsNewFrame;
00051 
00052 class nsISupportsArray;
00053 
00054 class nsIsIndexFrame : public nsAreaFrame,
00055                        public nsIAnonymousContentCreator,
00056                        public nsIDOMKeyListener,
00057                        public nsIStatefulFrame
00058 {
00059 public:
00060   nsIsIndexFrame();
00061   virtual ~nsIsIndexFrame();
00062 
00063   NS_IMETHOD Paint(nsPresContext*      aPresContext,
00064                    nsIRenderingContext& aRenderingContext,
00065                    const nsRect&        aDirtyRect,
00066                    nsFramePaintLayer    aWhichLayer,
00067                    PRUint32             aFlags = 0);
00068 
00069   // XXX Hack so we can squirrel away the pres context pointer for the KeyPress method
00070   NS_IMETHOD Init(nsPresContext*  aPresContext,
00071                   nsIContent*      aContent,
00072                   nsIFrame*        aParent,
00073                   nsStyleContext*  aContext,
00074                   nsIFrame*        aPrevInFlow) {
00075     mPresContext = aPresContext;
00076     return nsAreaFrame::Init(aPresContext, aContent, aParent, aContext, aPrevInFlow);
00077   }
00078 
00084   NS_IMETHOD KeyDown(nsIDOMEvent* aKeyEvent) { return NS_OK; }
00085 
00091   NS_IMETHOD KeyUp(nsIDOMEvent* aKeyEvent) { return NS_OK; }
00092 
00099   NS_IMETHOD KeyPress(nsIDOMEvent* aKeyEvent); // we only care when a key is pressed
00100 
00101   // nsIFormControlFrame
00102   NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr);
00103 
00104   NS_IMETHOD Reflow(nsPresContext*          aCX,
00105                     nsHTMLReflowMetrics&     aDesiredSize,
00106                     const nsHTMLReflowState& aReflowState,
00107                     nsReflowStatus&          aStatus);
00108 
00109   virtual PRBool IsLeaf() const;
00110 
00111 #ifdef NS_DEBUG
00112   NS_IMETHOD GetFrameName(nsAString& aResult) const;
00113 #endif
00114   NS_IMETHOD AttributeChanged(nsIContent*     aChild,
00115                               PRInt32         aNameSpaceID,
00116                               nsIAtom*        aAttribute,
00117                               PRInt32         aModType);
00118 
00119   void           SetFocus(PRBool aOn, PRBool aRepaint);
00120   void           ScrollIntoView(nsPresContext* aPresContext);
00121 
00122   // from nsIAnonymousContentCreator
00123   NS_IMETHOD CreateAnonymousContent(nsPresContext* aPresContext,
00124                                     nsISupportsArray& aChildList);
00125   NS_IMETHOD CreateFrameFor(nsPresContext*   aPresContext,
00126                             nsIContent *      aContent,
00127                             nsIFrame**        aFrame) { if (aFrame) *aFrame = nsnull; return NS_ERROR_FAILURE; }
00128 
00129   NS_IMETHOD HandleEvent(nsIDOMEvent* aEvent) { return NS_OK; }
00130 
00131   NS_IMETHOD OnSubmit(nsPresContext* aPresContext);
00132 
00133   //nsIStatefulFrame
00134   NS_IMETHOD SaveState(nsPresContext* aPresContext, nsPresState** aState);
00135   NS_IMETHOD RestoreState(nsPresContext* aPresContext, nsPresState* aState);
00136 
00137 protected:
00138   nsCOMPtr<nsITextContent> mTextContent;
00139   nsCOMPtr<nsIContent> mInputContent;
00140 
00141   // XXX Hack: pres context needed by function KeyPress() and SetFocus()
00142   nsPresContext*     mPresContext;  // weak reference
00143 
00144 private:
00145   NS_IMETHOD UpdatePromptLabel();
00146   NS_IMETHOD GetInputFrame(nsPresContext* aPresContext, nsIFormControlFrame** oFrame);
00147   NS_IMETHOD GetInputValue(nsPresContext* aPresContext, nsString& oString);
00148   NS_IMETHOD SetInputValue(nsPresContext* aPresContext, const nsString aString);
00149 
00150   void GetSubmitCharset(nsCString& oCharset);
00151   NS_IMETHOD GetEncoder(nsIUnicodeEncoder** encoder);
00152   char* UnicodeToNewBytes(const PRUnichar* aSrc, PRUint32 aLen, nsIUnicodeEncoder* encoder);
00153   void URLEncode(const nsString& aString, nsIUnicodeEncoder* encoder, nsString& oString);
00154 
00155   NS_IMETHOD_(nsrefcnt) AddRef() { return NS_OK; }
00156   NS_IMETHOD_(nsrefcnt) Release() { return NS_OK; }
00157 };
00158 
00159 #endif
00160 
00161