/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- * * The contents of this file are subject to the Netscape Public License * Version 1.0 (the "License"); you may not use this file except in * compliance with the License. You may obtain a copy of the License at * http://www.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS IS" * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See * the License for the specific language governing rights and limitations * under the License. * * The Original Code is Mozilla Communicator client code. * * The Initial Developer of the Original Code is Netscape Communications * Corporation. Portions created by Netscape are Copyright (C) 1998 * Netscape Communications Corporation. All Rights Reserved. */ #include "nsCOMPtr.h" #include "nsListControlFrame.h" #include "nsFormControlHelper.h" #include "nsHTMLIIDs.h" #include "nsHTMLAtoms.h" #include "nsIHTMLContent.h" #include "nsIFormControl.h" #include "nsINameSpaceManager.h" #include "nsIDeviceContext.h" #include "nsIDOMHTMLCollection.h" #include "nsIDOMHTMLSelectElement.h" #include "nsIDOMHTMLOptionElement.h" #include "nsIComboboxControlFrame.h" #include "nsIViewManager.h" #include "nsFormFrame.h" #include "nsIScrollableView.h" #include "nsIDOMHTMLOptGroupElement.h" #include "nsWidgetsCID.h" #include "nsIReflowCommand.h" // Constants const nscoord kMaxDropDownRows = 20; // This matches the setting for 4.x browsers const PRInt32 kNothingSelected = -1; const PRInt32 kMaxZ= 0x7fffffff; //XXX: Shouldn't there be a define somewhere for MaxInt for PRInt32 //XXX: This is temporary. It simulates psuedo states by using a attribute selector on // -moz-option-selected in the ua.css style sheet. This will not be needed when //The event state manager is functional. KMM const char * kMozSelected = "-moz-option-selected"; static NS_DEFINE_IID(kIContentIID, NS_ICONTENT_IID); static NS_DEFINE_IID(kIFormControlFrameIID, NS_IFORMCONTROLFRAME_IID); static NS_DEFINE_IID(kIScrollableViewIID, NS_ISCROLLABLEVIEW_IID); static NS_DEFINE_IID(kIListControlFrameIID, NS_ILISTCONTROLFRAME_IID); static NS_DEFINE_IID(kIDOMHTMLSelectElementIID, NS_IDOMHTMLSELECTELEMENT_IID); static NS_DEFINE_IID(kIDOMHTMLOptionElementIID, NS_IDOMHTMLOPTIONELEMENT_IID); static NS_DEFINE_IID(kIFrameIID, NS_IFRAME_IID); //---------------------------------------------------------------------- nsresult NS_NewListControlFrame(nsIFrame** aNewFrame) { NS_PRECONDITION(aNewFrame, "null OUT ptr"); if (nsnull == aNewFrame) { return NS_ERROR_NULL_POINTER; } nsListControlFrame* it = new nsListControlFrame; if (!it) { return NS_ERROR_OUT_OF_MEMORY; } *aNewFrame = it; return NS_OK; } //---------------------------------------------------------------------- nsListControlFrame::nsListControlFrame() { mHitFrame = nsnull; mSelectedIndex = kNothingSelected; mNumRows = 0; mNumSelections = 0; mComboboxFrame = nsnull; mFormFrame = nsnull; mDisplayed = PR_FALSE; mButtonDown = PR_FALSE; mLastFrame = nsnull; } //---------------------------------------------------------------------- nsListControlFrame::~nsListControlFrame() { mComboboxFrame = nsnull; mFormFrame = nsnull; } //---------------------------------------------------------------------- NS_IMPL_ADDREF(nsListControlFrame) NS_IMPL_RELEASE(nsListControlFrame) //---------------------------------------------------------------------- NS_IMETHODIMP nsListControlFrame::QueryInterface(const nsIID& aIID, void** aInstancePtr) { if (NULL == aInstancePtr) { return NS_ERROR_NULL_POINTER; } if (aIID.Equals(kIFormControlFrameIID)) { *aInstancePtr = (void*) ((nsIFormControlFrame*) this); return NS_OK; } if (aIID.Equals(kIListControlFrameIID)) { NS_ADDREF_THIS(); // Increase reference count for caller *aInstancePtr = (void *)((nsIListControlFrame*)this); return NS_OK; } return nsScrollFrame::QueryInterface(aIID, aInstancePtr); } //---------------------------------------------------------------------- NS_IMETHODIMP nsListControlFrame::GetFrameForPoint(const nsPoint& aPoint, nsIFrame** aFrame) { // Save the result of GetFrameForPointUsing in the mHitFrame member variable. // mHitFrame is used later in the HandleLikeListEvent to determine what was clicked on. // XXX: This is kludgy, but there doesn't seem to be a way to get what was just clicked // on in the HandleEvent. The GetFrameForPointUsing is always called before the HandleEvent. // nsresult rv; mHitFrame = nsnull; nsIFrame *childFrame; FirstChild(nsnull, &childFrame); rv = GetFrameForPointUsing(aPoint, nsnull, aFrame); if (NS_OK == rv) { if (*aFrame != this) { *aFrame = GetSelectableFrame(*aFrame); if (nsnull == *aFrame) { mHitFrame = this; } else { mHitFrame = *aFrame; } *aFrame = this; } return NS_OK; } *aFrame = this; return NS_ERROR_FAILURE; } //---------------------------------------------------------------------- nsresult nsListControlFrame::GetFrameForPointUsing(const nsPoint& aPoint, nsIAtom* aList, nsIFrame** aFrame) { nsIFrame* kid = nsnull; nsRect kidRect; nsPoint tmp; nsRect offset(0, 0, 0, 0); *aFrame = nsnull; nsIFrame* firstKid = nsnull; // Get the scrolled offset from the view. // // XXX:Hack. This should not be necessary. It is only required because we interpose on the // normal event flow by redirecting to the listbox using the SetVFlags(NS_DONT_CHECK_CHILDREN). // What we should really do is have a manager which the option items report there events to. // The listbox frame would be the manager for the option items. KMM. // // // This is needed because: // The scrolled view is below the nsListControlFrame's ScrollingView in // the view hierarchy. This presents a problem for event translation when the events // are re-directed with the nsView::SetVFlags(NS_DONT_CHECK_CHILDREN). Since // the handling of the view event is short-circuited at the nsListControlFrame's // scrolling view level mouse click events do not have the scolled offset added to them. // The view containing the offset is below the nsListControlFrame's scrolling // view, so the short-circuiting of the event processing provided by nsView:SetVFlags(NS_DONT_CHECK_CHILDREN) // prevents the scrolled view's offset from ever being added to the event's offset. // When nsListControlFrame::GetFrameForPoint is invoked the nsPoint passed in does not include the scrolled view offset, // so the frame returned will always be wrong when the listbox is scrolled. // As a hack we adjust for missing view offset by adding code to the nsListControlFrame::GetFrameForPoint which first // gets the ScrollableView associated with the nsListControlFrame and asks for it's GetScrollPosition offsets. These are // added to the point that is passed in so the correct frame is returned from nsListControlFrame::GetFrameForPoint. tmp.MoveTo(aPoint.x, aPoint.y); nsIView *view = nsnull; GetView(&view); if (nsnull != view) { nscoord offsetx; nscoord offsety; nsIScrollableView* scrollableView; if (NS_SUCCEEDED(view->QueryInterface(kIScrollableViewIID, (void **)&scrollableView))) { scrollableView->GetScrollPosition(offsetx, offsety); tmp.x += offsetx; tmp.y += offsety; // Note: scrollableView is not ref counted so it's interface is not NS_RELEASE'd } } // Remove the top border from the offset. nsMargin border; tmp.y -= mBorderOffsetY; mContentFrame->FirstChild(aList, &kid); while (nsnull != kid) { kid->GetRect(kidRect); if (kidRect.Contains(tmp)) { tmp.MoveTo(tmp.x - kidRect.x, tmp.y - kidRect.y); nsIContent * content; kid->GetContent(&content); static NS_DEFINE_IID(kIDOMHTMLOptionElementIID, NS_IDOMHTMLOPTIONELEMENT_IID); nsIDOMHTMLOptionElement* oe; if (content && (NS_OK == content->QueryInterface(kIDOMHTMLOptionElementIID, (void**) &oe))) { *aFrame = kid; NS_RELEASE(content); return NS_OK; } NS_RELEASE(content); return kid->GetFrameForPoint(tmp, aFrame); } kid->GetNextSibling(&kid); } mContentFrame->FirstChild(aList, &kid); while (nsnull != kid) { nsFrameState state; kid->GetFrameState(&state); if (NS_FRAME_OUTSIDE_CHILDREN & state) { kid->GetRect(kidRect); tmp.MoveTo(tmp.x - kidRect.x, tmp.y - kidRect.y); if (NS_OK == kid->GetFrameForPoint(tmp, aFrame)) { return NS_OK; } } kid->GetNextSibling(&kid); } *aFrame = this; return NS_ERROR_FAILURE; } //---------------------------------------------------------------------- // Reflow is overriden to constrain the listbox height to the number of rows and columns // specified. // NS_IMETHODIMP nsListControlFrame::Reflow(nsIPresContext& aPresContext, nsHTMLReflowMetrics& aDesiredSize, const nsHTMLReflowState& aReflowState, nsReflowStatus& aStatus) { // Strategy: Let the inherited reflow happen as though the width and height of the // ScrollFrame are big enough to allow the listbox to // shrink to fit the longest option element line in the list. // The desired width and height returned by the inherited reflow is returned, // unless one of the following has been specified. // 1. A css width has been specified. // 2. The size has been specified. // 3. The css height has been specified, but the number of rows has not. // The size attribute overrides the height setting but the height setting // should be honored if there isn't a size specified. // Determine the desired width + height for the listbox + aDesiredSize.width = 0; aDesiredSize.height = 0; //--Calculate a width just big enough for the scrollframe to shrink around the //longest element in the list nsHTMLReflowState secondPassState(aReflowState); nsHTMLReflowState firstPassState(aReflowState); // Get the size of option elements inside the listbox // Compute the width based on the longest line in the listbox. firstPassState.computedWidth = NS_UNCONSTRAINEDSIZE; firstPassState.computedHeight = NS_UNCONSTRAINEDSIZE; firstPassState.availableWidth = NS_UNCONSTRAINEDSIZE; firstPassState.availableHeight = NS_UNCONSTRAINEDSIZE; nsSize scrolledAreaSize(0,0); nsHTMLReflowMetrics scrolledAreaDesiredSize(&scrolledAreaSize); if (eReflowReason_Incremental == firstPassState.reason) { //XXX: Why do we have to change the reflow type in this //case? If we don't an assert in the nsScrollFrame::Reflow prevents //execution from continuing. Is the assertion in nsScrollFrame bogus? nsIFrame* targetFrame; firstPassState.reflowCommand->GetTarget(targetFrame); if (this == targetFrame) { nsIReflowCommand::ReflowType type; aReflowState.reflowCommand->GetType(type); firstPassState.reason = eReflowReason_StyleChange; firstPassState.reflowCommand = nsnull; } } nsScrollFrame::Reflow(aPresContext, scrolledAreaDesiredSize, firstPassState, aStatus); // Compute the bounding box of the contents of the list using the area // calculated by the first reflow as a starting point. nscoord scrolledAreaWidth = scrolledAreaDesiredSize.maxElementSize->width; nscoord scrolledAreaHeight = scrolledAreaDesiredSize.height; // The first reflow produces a box with the scrollbar width and borders // added in so we need to subtract them out. // Retrieve the scrollbar's width and height float sbWidth = 0.0; float sbHeight = 0.0;; nsCOMPtr dc; aPresContext.GetDeviceContext(getter_AddRefs(dc)); dc->GetScrollBarDimensions(sbWidth, sbHeight); // Convert to nscoord's by rounding nscoord scrollbarWidth = NSToCoordRound(sbWidth); nscoord scrollbarHeight = NSToCoordRound(sbHeight); // Subtract out the scrollbar width scrolledAreaWidth -= scrollbarWidth; // Subtract out the borders nsMargin border; if (!aReflowState.mStyleSpacing->GetBorder(border)) { border.SizeTo(0, 0, 0, 0); } //XXX: Should just get the border.top when needed instead of //caching it. mBorderOffsetY = border.top; scrolledAreaWidth -= (border.left + border.right); scrolledAreaHeight -= (border.top + border.bottom); // Now the scrolledAreaWidth and scrolledAreaHeight are exactly // wide and high enough to enclose their contents nscoord visibleWidth = 0; if (IsInDropDownMode() == PR_TRUE) { // Always set the width to be // XXX: TODO The width of the list should be passed in so it can // be set to the same as the text box + dropdown arrow. visibleWidth = scrolledAreaWidth; if (nsnull != mComboboxFrame) { nsRect comboRect; nsIFrame *comboFrame = nsnull; if (NS_SUCCEEDED(mComboboxFrame->QueryInterface(kIFrameIID, (void **)&comboFrame))) { comboFrame->GetRect(comboRect); visibleWidth = comboRect.width; visibleWidth -= (border.left + border.right); } } } else { if (NS_UNCONSTRAINEDSIZE == aReflowState.computedWidth) { visibleWidth = scrolledAreaWidth; } else { visibleWidth = aReflowState.computedWidth; } } // Determine if a scrollbar will be needed, If so we need to add // enough the width to allow for the scrollbar. // The scrollbar will be needed under two conditions: // (size * heightOfaRow) < scrolledAreaHeight or // the height set through Style < scrolledAreaHeight. // Calculate the height of a single row in the listbox or dropdown list // Note: It is calculated based on what layout returns for the maxElement // size, rather than trying to take the scrolledAreaHeight and dividing by the number // of option elements. The reason is that their may be option groups in addition to // option elements. Either of which may be visible or invisible. PRInt32 heightOfARow = scrolledAreaDesiredSize.maxElementSize->height; heightOfARow -= (border.top + border.bottom); nscoord visibleHeight = 0; if (IsInDropDownMode() == PR_TRUE) { // Compute the visible height of the drop-down list // The dropdown list height is the smaller of it's height setting or the height // of the smallest box that can drawn around it's contents. visibleHeight = scrolledAreaHeight; if (visibleHeight > (kMaxDropDownRows * heightOfARow)) visibleHeight = (kMaxDropDownRows * heightOfARow); } else { // Calculate the visible height of the listbox if (NS_UNCONSTRAINEDSIZE != aReflowState.computedHeight) { visibleHeight = aReflowState.computedHeight; } else { visibleHeight = mNumRows * heightOfARow; } } PRBool needsVerticalScrollbar = PR_FALSE; if (visibleHeight < scrolledAreaHeight) { needsVerticalScrollbar = PR_TRUE; } if ((needsVerticalScrollbar) && (IsInDropDownMode() == PR_FALSE)) { visibleWidth += scrollbarWidth; } // Do a second reflow with the adjusted width and height settings // This sets up all of the frames with the correct width and height. secondPassState.computedWidth = visibleWidth; secondPassState.computedHeight = visibleHeight; secondPassState.reason = eReflowReason_Resize; nsScrollFrame::Reflow(aPresContext, aDesiredSize, secondPassState, aStatus); // Set the max element size to be the same as the desired element size. if (nsnull != aDesiredSize.maxElementSize) { aDesiredSize.maxElementSize->width = aDesiredSize.width; aDesiredSize.maxElementSize->height = aDesiredSize.height; } aStatus = NS_FRAME_COMPLETE; mDisplayed = PR_TRUE; return NS_OK; } //-------------------------------------------------------------- NS_IMETHODIMP nsListControlFrame::GetFormContent(nsIContent*& aContent) const { nsIContent* content; nsresult rv; rv = GetContent(&content); aContent = content; return rv; } //-------------------------------------------------------------- NS_IMETHODIMP nsListControlFrame::GetFont(nsIPresContext* aPresContext, nsFont& aFont) { nsFormControlHelper::GetFont(this, aPresContext, mStyleContext, aFont); return NS_OK; } PRBool nsListControlFrame::IsOptionElement(nsIContent* aContent) { PRBool result = PR_FALSE; nsIDOMHTMLOptionElement* oe = nsnull; if (NS_SUCCEEDED(aContent->QueryInterface(kIDOMHTMLOptionElementIID, (void**) &oe))) { if (oe != nsnull) { result = PR_TRUE; NS_RELEASE(oe); } } return result; } PRBool nsListControlFrame::IsOptionElementFrame(nsIFrame *aFrame) { nsIContent *content = nsnull; aFrame->GetContent(&content); PRBool result = PR_FALSE; if (nsnull != content) { result = IsOptionElement(content); NS_RELEASE(content); } return(result); } // Go up the frame tree looking for the first ancestor that has content // which is selectable nsIFrame *nsListControlFrame::GetSelectableFrame(nsIFrame *aFrame) { nsIFrame* selectedFrame = aFrame; while ((nsnull != selectedFrame) && (PR_FALSE ==IsOptionElementFrame(selectedFrame))) { selectedFrame->GetParent(&selectedFrame); } return(selectedFrame); } void nsListControlFrame::ForceRedraw() { //XXX: Hack. This should not be needed. The problem is DisplaySelected //and DisplayDeselected set and unset an attribute on generic HTML content //which does not know that it should repaint as the result of the attribute //being set. This should not be needed once the event state manager handles //selection. nsFormControlHelper::ForceDrawFrame(this); } // XXX: Here we introduce a new -moz-option-selected attribute so a attribute // selecitor n the ua.css can change the style when the option is selected. void nsListControlFrame::DisplaySelected(nsIContent* aContent) { //XXX: This is temporary. It simulates psuedo states by using a attribute selector on // -moz-option-selected in the ua.css style sheet. This will not be needed when // The event state manager is functional. KMM nsCOMPtr selectedAtom ( dont_QueryInterface(NS_NewAtom(kMozSelected))); if (PR_TRUE == mDisplayed) { aContent->SetAttribute(kNameSpaceID_None, selectedAtom, "", PR_TRUE); ForceRedraw(); } else { aContent->SetAttribute(kNameSpaceID_None, selectedAtom, "", PR_FALSE); } } void nsListControlFrame::DisplayDeselected(nsIContent* aContent) { //XXX: This is temporary. It simulates psuedo states by using a attribute selector on // -moz-option-selected in the ua.css style sheet. This will not be needed when // The event state manager is functional. KMM nsCOMPtr selectedAtom ( dont_QueryInterface(NS_NewAtom(kMozSelected))); if (PR_TRUE == mDisplayed) { aContent->UnsetAttribute(kNameSpaceID_None, selectedAtom, PR_TRUE); ForceRedraw(); } else { aContent->UnsetAttribute(kNameSpaceID_None, selectedAtom, PR_FALSE); } } //---------------------------------------------------------------------- PRInt32 nsListControlFrame::GetSelectedIndex(nsIFrame *aHitFrame) { PRInt32 index = kNothingSelected; // Get the content of the frame that was selected nsIContent* selectedContent = nsnull; NS_ASSERTION(aHitFrame, "No frame for html