/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=2 sw=2 et tw=78: */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (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/MPL/ * * 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.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Original Author: David W. Hyatt (hyatt@netscape.com) * Mike Pinkerton (pinkerton@netscape.com) * Dean Tessman * Ben Goodger * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsMenuPopupFrame.h" #include "nsGkAtoms.h" #include "nsIContent.h" #include "prtypes.h" #include "nsIAtom.h" #include "nsPresContext.h" #include "nsStyleContext.h" #include "nsCSSRendering.h" #include "nsINameSpaceManager.h" #include "nsIViewManager.h" #include "nsWidgetsCID.h" #include "nsMenuFrame.h" #include "nsMenuBarFrame.h" #include "nsPopupSetFrame.h" #include "nsEventDispatcher.h" #include "nsPIDOMWindow.h" #include "nsIDOMScreen.h" #include "nsIPresShell.h" #include "nsFrameManager.h" #include "nsIDocument.h" #include "nsIDeviceContext.h" #include "nsRect.h" #include "nsILookAndFeel.h" #include "nsIComponentManager.h" #include "nsBoxLayoutState.h" #include "nsIScrollableView.h" #include "nsIScrollableFrame.h" #include "nsGUIEvent.h" #include "nsIRootBox.h" #include "nsIDocShellTreeItem.h" #include "nsReadableUtils.h" #include "nsUnicharUtils.h" #include "nsLayoutUtils.h" #include "nsContentUtils.h" #include "nsCSSFrameConstructor.h" #include "nsIEventStateManager.h" #include "nsIBoxLayout.h" #include "nsIPopupBoxObject.h" #include "nsIReflowCallback.h" #include "nsBindingManager.h" #include "nsIDocShellTreeOwner.h" #include "nsIBaseWindow.h" #ifdef XP_WIN #include "nsISound.h" #endif const PRInt32 kMaxZ = 0x7fffffff; //XXX: Shouldn't there be a define somewhere for MaxInt for PRInt32 PRInt8 nsMenuPopupFrame::sDefaultLevelParent = -1; // NS_NewMenuPopupFrame // // Wrapper for creating a new menu popup container // nsIFrame* NS_NewMenuPopupFrame(nsIPresShell* aPresShell, nsStyleContext* aContext) { return new (aPresShell) nsMenuPopupFrame (aPresShell, aContext); } // // nsMenuPopupFrame ctor // nsMenuPopupFrame::nsMenuPopupFrame(nsIPresShell* aShell, nsStyleContext* aContext) :nsBoxFrame(aShell, aContext), mCurrentMenu(nsnull), mPopupAlignment(POPUPALIGNMENT_NONE), mPopupAnchor(POPUPALIGNMENT_NONE), mPopupType(ePopupTypePanel), mPopupState(ePopupClosed), mIsOpenChanged(PR_FALSE), mIsContextMenu(PR_FALSE), mAdjustOffsetForContextMenu(PR_FALSE), mGeneratedChildren(PR_FALSE), mMenuCanOverlapOSBar(PR_FALSE), mShouldAutoPosition(PR_TRUE), mConsumeRollupEvent(nsIPopupBoxObject::ROLLUP_DEFAULT), mInContentShell(PR_TRUE), mPrefSize(-1, -1) { if (sDefaultLevelParent >= 0) return; sDefaultLevelParent = nsContentUtils::GetBoolPref("ui.panel.default_level_parent", PR_FALSE); } // ctor NS_IMETHODIMP nsMenuPopupFrame::Init(nsIContent* aContent, nsIFrame* aParent, nsIFrame* aPrevInFlow) { nsresult rv = nsBoxFrame::Init(aContent, aParent, aPrevInFlow); NS_ENSURE_SUCCESS(rv, rv); nsPresContext* presContext = PresContext(); // lookup if we're allowed to overlap the OS bar (menubar/taskbar) from the // look&feel object PRBool tempBool; presContext->LookAndFeel()-> GetMetric(nsILookAndFeel::eMetric_MenusCanOverlapOSBar, tempBool); mMenuCanOverlapOSBar = tempBool; rv = CreateViewForFrame(presContext, this, GetStyleContext(), PR_TRUE, PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); // XXX Hack. The popup's view should float above all other views, // so we use the nsIView::SetFloating() to tell the view manager // about that constraint. nsIView* ourView = GetView(); nsIViewManager* viewManager = ourView->GetViewManager(); viewManager->SetViewFloating(ourView, PR_TRUE); mPopupType = ePopupTypePanel; nsIDocument* doc = aContent->GetOwnerDoc(); if (doc) { PRInt32 namespaceID; nsCOMPtr tag = doc->BindingManager()->ResolveTag(aContent, &namespaceID); if (namespaceID == kNameSpaceID_XUL) { if (tag == nsGkAtoms::menupopup || tag == nsGkAtoms::popup) mPopupType = ePopupTypeMenu; else if (tag == nsGkAtoms::tooltip) mPopupType = ePopupTypeTooltip; } } nsCOMPtr cont = PresContext()->GetContainer(); nsCOMPtr dsti = do_QueryInterface(cont); PRInt32 type = -1; if (dsti && NS_SUCCEEDED(dsti->GetItemType(&type)) && type == nsIDocShellTreeItem::typeChrome) mInContentShell = PR_FALSE; // To improve performance, create the widget for the popup only if it is not // a leaf. Leaf popups such as menus will create their widgets later when // the popup opens. if (!IsLeaf() && !ourView->HasWidget()) { CreateWidgetForView(ourView); } return rv; } PRBool nsMenuPopupFrame::IsNoAutoHide() { // Panels with noautohide="true" don't hide when the mouse is clicked // outside of them, or when another application is made active. Non-autohide // panels cannot be used in content windows. return (!mInContentShell && mPopupType == ePopupTypePanel && mContent->AttrValueIs(kNameSpaceID_None, nsGkAtoms::noautohide, nsGkAtoms::_true, eIgnoreCase)); } PRBool nsMenuPopupFrame::IsTopMost() { // If this panel is not a panel, this is always a top-most popup if (mPopupType != ePopupTypePanel) return PR_TRUE; // If this panel is a noautohide panel, it should appear just above the parent // window. if (IsNoAutoHide()) return PR_FALSE; // Otherwise, check the topmost attribute. if (mContent->AttrValueIs(kNameSpaceID_None, nsGkAtoms::level, nsGkAtoms::top, eIgnoreCase)) return PR_TRUE; if (mContent->AttrValueIs(kNameSpaceID_None, nsGkAtoms::level, nsGkAtoms::parent, eIgnoreCase)) return PR_FALSE; // Otherwise, the result depends on the platform. return sDefaultLevelParent ? PR_TRUE : PR_FALSE; } void nsMenuPopupFrame::EnsureWidget() { nsIView* ourView = GetView(); if (!ourView->HasWidget()) { NS_ASSERTION(!mGeneratedChildren && !GetFirstChild(nsnull), "Creating widget for MenuPopupFrame with children"); CreateWidgetForView(ourView); } } nsresult nsMenuPopupFrame::CreateWidgetForView(nsIView* aView) { // Create a widget for ourselves. nsWidgetInitData widgetData; widgetData.mWindowType = eWindowType_popup; widgetData.mBorderStyle = eBorderStyle_default; widgetData.clipSiblings = PR_TRUE; widgetData.mPopupHint = mPopupType; PRBool viewHasTransparentContent = !mInContentShell && (eTransparencyTransparent == nsLayoutUtils::GetFrameTransparency(this)); nsIContent* parentContent = GetContent()->GetParent(); nsIAtom *tag = nsnull; if (parentContent) tag = parentContent->Tag(); widgetData.mDropShadow = !(viewHasTransparentContent || tag == nsGkAtoms::menulist); // panels which are not topmost need a parent widget. This allows them to // always appear in front of the parent window but behind other windows that // should be in front of it. nsCOMPtr parentWidget; if (!IsTopMost()) { nsCOMPtr cont = PresContext()->GetContainer(); nsCOMPtr dsti = do_QueryInterface(cont); if (!dsti) return NS_ERROR_FAILURE; nsCOMPtr treeOwner; dsti->GetTreeOwner(getter_AddRefs(treeOwner)); if (!treeOwner) return NS_ERROR_FAILURE; nsCOMPtr baseWindow(do_QueryInterface(treeOwner)); if (baseWindow) baseWindow->GetMainWidget(getter_AddRefs(parentWidget)); } #if defined(XP_MACOSX) || defined(XP_BEOS) static NS_DEFINE_IID(kCPopupCID, NS_POPUP_CID); aView->CreateWidget(kCPopupCID, &widgetData, nsnull, PR_TRUE, PR_TRUE, eContentTypeUI, parentWidget); #else static NS_DEFINE_IID(kCChildCID, NS_CHILD_CID); aView->CreateWidget(kCChildCID, &widgetData, nsnull, PR_TRUE, PR_TRUE, eContentTypeInherit, parentWidget); #endif aView->GetWidget()->SetTransparencyMode(viewHasTransparentContent ? eTransparencyTransparent : eTransparencyOpaque); return NS_OK; } // this class is used for dispatching popupshowing events asynchronously. class nsXULPopupShownEvent : public nsRunnable { public: nsXULPopupShownEvent(nsIContent *aPopup, nsPresContext* aPresContext) : mPopup(aPopup), mPresContext(aPresContext) { } NS_IMETHOD Run() { nsMouseEvent event(PR_TRUE, NS_XUL_POPUP_SHOWN, nsnull, nsMouseEvent::eReal); return nsEventDispatcher::Dispatch(mPopup, mPresContext, &event); } private: nsCOMPtr mPopup; nsRefPtr mPresContext; }; NS_IMETHODIMP nsMenuPopupFrame::SetInitialChildList(nsIAtom* aListName, nsIFrame* aChildList) { // unless the list is empty, indicate that children have been generated. if (aChildList) mGeneratedChildren = PR_TRUE; return nsBoxFrame::SetInitialChildList(aListName, aChildList); } PRBool nsMenuPopupFrame::IsLeaf() const { if (mGeneratedChildren) return PR_FALSE; if (mPopupType != ePopupTypeMenu) { // any panel with a type attribute, such as the autocomplete popup, // is always generated right away. return !mContent->HasAttr(kNameSpaceID_None, nsGkAtoms::type); } // menu popups generate their child frames lazily only when opened, so // behave like a leaf frame. However, generate child frames normally if // the parent menu has a sizetopopup attribute. In this case the size of // the parent menu is dependant on the size of the popup, so the frames // need to exist in order to calculate this size. nsIContent* parentContent = mContent->GetParent(); return (parentContent && !parentContent->HasAttr(kNameSpaceID_None, nsGkAtoms::sizetopopup)); } void nsMenuPopupFrame::SetPreferredBounds(nsBoxLayoutState& aState, const nsRect& aRect) { nsBox::SetBounds(aState, aRect, PR_FALSE); mPrefSize = aRect.Size(); } void nsMenuPopupFrame::AdjustView() { if ((mPopupState == ePopupOpen || mPopupState == ePopupOpenAndVisible) && mGeneratedChildren) { // if the popup has just opened, make sure the scrolled window is at 0,0 if (mIsOpenChanged) { nsIBox* child = GetChildBox(); nsCOMPtr scrollframe(do_QueryInterface(child)); if (scrollframe) scrollframe->ScrollTo(nsPoint(0,0)); } nsIView* view = GetView(); nsIViewManager* viewManager = view->GetViewManager(); nsRect rect = GetRect(); rect.x = rect.y = 0; viewManager->ResizeView(view, rect); viewManager->SetViewVisibility(view, nsViewVisibility_kShow); mPopupState = ePopupOpenAndVisible; nsPresContext* pc = PresContext(); nsContainerFrame::SyncFrameViewProperties(pc, this, nsnull, view, 0); // fire popupshown event when the state has changed if (mIsOpenChanged) { mIsOpenChanged = PR_FALSE; nsCOMPtr event = new nsXULPopupShownEvent(GetContent(), pc); NS_DispatchToCurrentThread(event); } } } void nsMenuPopupFrame::InitPositionFromAnchorAlign(const nsAString& aAnchor, const nsAString& aAlign) { if (aAnchor.EqualsLiteral("topleft")) mPopupAnchor = POPUPALIGNMENT_TOPLEFT; else if (aAnchor.EqualsLiteral("topright")) mPopupAnchor = POPUPALIGNMENT_TOPRIGHT; else if (aAnchor.EqualsLiteral("bottomleft")) mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT; else if (aAnchor.EqualsLiteral("bottomright")) mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT; else mPopupAnchor = POPUPALIGNMENT_NONE; if (aAlign.EqualsLiteral("topleft")) mPopupAlignment = POPUPALIGNMENT_TOPLEFT; else if (aAlign.EqualsLiteral("topright")) mPopupAlignment = POPUPALIGNMENT_TOPRIGHT; else if (aAlign.EqualsLiteral("bottomleft")) mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT; else if (aAlign.EqualsLiteral("bottomright")) mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT; else mPopupAlignment = POPUPALIGNMENT_NONE; } void nsMenuPopupFrame::InitializePopup(nsIContent* aAnchorContent, const nsAString& aPosition, PRInt32 aXPos, PRInt32 aYPos, PRBool aAttributesOverride) { EnsureWidget(); mPopupState = ePopupShowing; mAnchorContent = aAnchorContent; mXPos = aXPos; mYPos = aYPos; mAdjustOffsetForContextMenu = PR_FALSE; // if aAttributesOverride is true, then the popupanchor, popupalign and // position attributes on the override those values passed in. // If false, those attributes are only used if the values passed in are empty if (aAnchorContent) { nsAutoString anchor, align, position; mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::popupanchor, anchor); mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::popupalign, align); mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::position, position); if (aAttributesOverride) { // if the attributes are set, clear the offset position. Otherwise, // the offset is used to adjust the position from the anchor point if (anchor.IsEmpty() && align.IsEmpty() && position.IsEmpty()) position.Assign(aPosition); else mXPos = mYPos = 0; } else if (!aPosition.IsEmpty()) { position.Assign(aPosition); } if (position.EqualsLiteral("before_start")) { mPopupAnchor = POPUPALIGNMENT_TOPLEFT; mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT; } else if (position.EqualsLiteral("before_end")) { mPopupAnchor = POPUPALIGNMENT_TOPRIGHT; mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT; } else if (position.EqualsLiteral("after_start")) { mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT; mPopupAlignment = POPUPALIGNMENT_TOPLEFT; } else if (position.EqualsLiteral("after_end")) { mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT; mPopupAlignment = POPUPALIGNMENT_TOPRIGHT; } else if (position.EqualsLiteral("start_before")) { mPopupAnchor = POPUPALIGNMENT_TOPLEFT; mPopupAlignment = POPUPALIGNMENT_TOPRIGHT; } else if (position.EqualsLiteral("start_after")) { mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT; mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT; } else if (position.EqualsLiteral("end_before")) { mPopupAnchor = POPUPALIGNMENT_TOPRIGHT; mPopupAlignment = POPUPALIGNMENT_TOPLEFT; } else if (position.EqualsLiteral("end_after")) { mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT; mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT; } else if (position.EqualsLiteral("overlap")) { mPopupAnchor = POPUPALIGNMENT_TOPLEFT; mPopupAlignment = POPUPALIGNMENT_TOPLEFT; } else if (position.EqualsLiteral("after_pointer")) { mPopupAnchor = POPUPALIGNMENT_NONE; mPopupAlignment = POPUPALIGNMENT_NONE; // XXXndeakin this is supposed to anchor vertically after, but with the // horizontal position as the mouse pointer. mYPos += 21; } else { InitPositionFromAnchorAlign(anchor, align); } } mScreenXPos = -1; mScreenYPos = -1; if (aAttributesOverride) { // Use |left| and |top| dimension attributes to position the popup if // present, as they may have been persisted. nsAutoString left, top; mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::left, left); mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::top, top); PRInt32 err; if (!left.IsEmpty()) { PRInt32 x = left.ToInteger(&err); if (NS_SUCCEEDED(err)) mScreenXPos = x; } if (!top.IsEmpty()) { PRInt32 y = top.ToInteger(&err); if (NS_SUCCEEDED(err)) mScreenYPos = y; } } } void nsMenuPopupFrame::InitializePopupAtScreen(PRInt32 aXPos, PRInt32 aYPos, PRBool aIsContextMenu) { EnsureWidget(); mPopupState = ePopupShowing; mAnchorContent = nsnull; mScreenXPos = aXPos; mScreenYPos = aYPos; mPopupAnchor = POPUPALIGNMENT_NONE; mPopupAlignment = POPUPALIGNMENT_NONE; mIsContextMenu = aIsContextMenu; mAdjustOffsetForContextMenu = aIsContextMenu; } void nsMenuPopupFrame::InitializePopupWithAnchorAlign(nsIContent* aAnchorContent, nsAString& aAnchor, nsAString& aAlign, PRInt32 aXPos, PRInt32 aYPos) { EnsureWidget(); mPopupState = ePopupShowing; mAdjustOffsetForContextMenu = PR_FALSE; // this popup opening function is provided for backwards compatibility // only. It accepts either coordinates or an anchor and alignment value // but doesn't use both together. if (aXPos == -1 && aYPos == -1) { mAnchorContent = aAnchorContent; mScreenXPos = -1; mScreenYPos = -1; mXPos = 0; mYPos = 0; InitPositionFromAnchorAlign(aAnchor, aAlign); } else { mAnchorContent = nsnull; mPopupAnchor = POPUPALIGNMENT_NONE; mPopupAlignment = POPUPALIGNMENT_NONE; mScreenXPos = aXPos; mScreenYPos = aYPos; mXPos = aXPos; mYPos = aYPos; } } void PR_CALLBACK LazyGeneratePopupDone(nsIContent* aPopup, nsIFrame* aFrame, void* aArg) { // be safe and check the frame type if (aFrame->GetType() == nsGkAtoms::menuPopupFrame) { nsWeakFrame weakFrame(aFrame); nsMenuPopupFrame* popupFrame = static_cast(aFrame); nsXULPopupManager* pm = nsXULPopupManager::GetInstance(); if (pm && popupFrame->IsMenu()) { nsCOMPtr popup = aPopup; pm->UpdateMenuItems(popup); if (!weakFrame.IsAlive()) return; PRBool selectFirstItem = (PRBool)NS_PTR_TO_INT32(aArg); if (selectFirstItem) { nsMenuFrame* next = pm->GetNextMenuItem(popupFrame, nsnull, PR_TRUE); popupFrame->SetCurrentMenuItem(next); } } if (weakFrame.IsAlive()) { popupFrame->PresContext()->PresShell()-> FrameNeedsReflow(popupFrame, nsIPresShell::eTreeChange, NS_FRAME_HAS_DIRTY_CHILDREN); } } } PRBool nsMenuPopupFrame::ShowPopup(PRBool aIsContextMenu, PRBool aSelectFirstItem) { mIsContextMenu = aIsContextMenu; PRBool hasChildren = PR_FALSE; if (mPopupState == ePopupShowing) { mPopupState = ePopupOpen; mIsOpenChanged = PR_TRUE; nsIFrame* parent = GetParent(); if (parent && parent->GetType() == nsGkAtoms::menuFrame) { nsWeakFrame weakFrame(this); (static_cast(parent))->PopupOpened(); if (!weakFrame.IsAlive()) return PR_FALSE; } // the frames for the child menus have not been created yet, so tell the // frame constructor to build them if (mFrames.IsEmpty() && !mGeneratedChildren) { PresContext()->PresShell()->FrameConstructor()-> AddLazyChildren(mContent, LazyGeneratePopupDone, NS_INT32_TO_PTR(aSelectFirstItem)); } else { hasChildren = PR_TRUE; PresContext()->PresShell()-> FrameNeedsReflow(this, nsIPresShell::eTreeChange, NS_FRAME_HAS_DIRTY_CHILDREN); } } mShouldAutoPosition = PR_TRUE; return hasChildren; } void nsMenuPopupFrame::HidePopup(PRBool aDeselectMenu, nsPopupState aNewState) { NS_ASSERTION(aNewState == ePopupClosed || aNewState == ePopupInvisible, "popup being set to unexpected state"); // don't hide the popup when it isn't open if (mPopupState == ePopupClosed || mPopupState == ePopupShowing) return; // when invisible and about to be closed, HidePopup has already been called, // so just set the new state to closed and return if (mPopupState == ePopupInvisible) { if (aNewState == ePopupClosed) mPopupState = ePopupClosed; return; } mPopupState = aNewState; if (IsMenu()) SetCurrentMenuItem(nsnull); mIncrementalString.Truncate(); mIsOpenChanged = PR_FALSE; mCurrentMenu = nsnull; // make sure no current menu is set nsIView* view = GetView(); nsIViewManager* viewManager = view->GetViewManager(); viewManager->SetViewVisibility(view, nsViewVisibility_kHide); viewManager->ResizeView(view, nsRect(0, 0, 0, 0)); FireDOMEvent(NS_LITERAL_STRING("DOMMenuInactive"), mContent); // XXX, bug 137033, In Windows, if mouse is outside the window when the menupopup closes, no // mouse_enter/mouse_exit event will be fired to clear current hover state, we should clear it manually. // This code may not the best solution, but we can leave it here until we find the better approach. nsIEventStateManager *esm = PresContext()->EventStateManager(); PRInt32 state; esm->GetContentState(mContent, state); if (state & NS_EVENT_STATE_HOVER) esm->SetContentState(nsnull, NS_EVENT_STATE_HOVER); nsIFrame* parent = GetParent(); if (parent && parent->GetType() == nsGkAtoms::menuFrame) { (static_cast(parent))->PopupClosed(aDeselectMenu); } } void nsMenuPopupFrame::InvalidateInternal(const nsRect& aDamageRect, nscoord aX, nscoord aY, nsIFrame* aForChild, PRBool aImmediate) { InvalidateRoot(aDamageRect, aX, aY, aImmediate); } void nsMenuPopupFrame::GetLayoutFlags(PRUint32& aFlags) { aFlags = NS_FRAME_NO_SIZE_VIEW | NS_FRAME_NO_MOVE_VIEW | NS_FRAME_NO_VISIBILITY; } /////////////////////////////////////////////////////////////////////////////// // GetRootViewForPopup // Retrieves the view for the popup widget that contains the given frame. // If the given frame is not contained by a popup widget, return the // root view of the root viewmanager. nsIView* nsMenuPopupFrame::GetRootViewForPopup(nsIFrame* aStartFrame) { nsIView* view = aStartFrame->GetClosestView(); NS_ASSERTION(view, "frame must have a closest view!"); while (view) { // Walk up the view hierarchy looking for a view whose widget has a // window type of eWindowType_popup - in other words a popup window // widget. If we find one, this is the view we want. nsIWidget* widget = view->GetWidget(); if (widget) { nsWindowType wtype; widget->GetWindowType(wtype); if (wtype == eWindowType_popup) { return view; } } nsIView* temp = view->GetParent(); if (!temp) { // Otherwise, we've walked all the way up to the root view and not // found a view for a popup window widget. Just return the root view. return view; } view = temp; } return nsnull; } // // AdjustPositionForAnchorAlign // // Uses the anchor and alignment to move the popup around and anchor it to its // parent. |outFlushWithTopBottom| will be TRUE if the popup is flush with // either the top or bottom edge of its parent, and FALSE if it is flush with // the left or right edge of the parent. // void nsMenuPopupFrame::AdjustPositionForAnchorAlign(PRInt32* ioXPos, PRInt32* ioYPos, const nsSize & inParentSize, PRBool* outFlushWithTopBottom) { PRInt8 popupAnchor(mPopupAnchor); PRInt8 popupAlign(mPopupAlignment); if (GetStyleVisibility()->mDirection == NS_STYLE_DIRECTION_RTL) { popupAnchor = -popupAnchor; popupAlign = -popupAlign; } // Adjust position for margins at the aligned corner nsMargin margin; GetStyleMargin()->GetMargin(margin); if (popupAlign == POPUPALIGNMENT_TOPLEFT) { *ioXPos += margin.left; *ioYPos += margin.top; } else if (popupAlign == POPUPALIGNMENT_TOPRIGHT) { *ioXPos += margin.right; *ioYPos += margin.top; } else if (popupAlign == POPUPALIGNMENT_BOTTOMLEFT) { *ioXPos += margin.left; *ioYPos += margin.bottom; } else if (popupAlign == POPUPALIGNMENT_BOTTOMRIGHT) { *ioXPos += margin.right; *ioYPos += margin.bottom; } if (popupAnchor == POPUPALIGNMENT_TOPRIGHT && popupAlign == POPUPALIGNMENT_TOPLEFT) { *ioXPos += inParentSize.width; } else if (popupAnchor == POPUPALIGNMENT_TOPLEFT && popupAlign == POPUPALIGNMENT_TOPLEFT) { *outFlushWithTopBottom = PR_TRUE; } else if (popupAnchor == POPUPALIGNMENT_TOPRIGHT && popupAlign == POPUPALIGNMENT_BOTTOMRIGHT) { *ioXPos -= (mRect.width - inParentSize.width); *ioYPos -= mRect.height; *outFlushWithTopBottom = PR_TRUE; } else if (popupAnchor == POPUPALIGNMENT_BOTTOMRIGHT && popupAlign == POPUPALIGNMENT_BOTTOMLEFT) { *ioXPos += inParentSize.width; *ioYPos -= (mRect.height - inParentSize.height); } else if (popupAnchor == POPUPALIGNMENT_BOTTOMRIGHT && popupAlign == POPUPALIGNMENT_TOPRIGHT) { *ioXPos -= (mRect.width - inParentSize.width); *ioYPos += inParentSize.height; *outFlushWithTopBottom = PR_TRUE; } else if (popupAnchor == POPUPALIGNMENT_TOPLEFT && popupAlign == POPUPALIGNMENT_TOPRIGHT) { *ioXPos -= mRect.width; } else if (popupAnchor == POPUPALIGNMENT_TOPLEFT && popupAlign == POPUPALIGNMENT_BOTTOMLEFT) { *ioYPos -= mRect.height; *outFlushWithTopBottom = PR_TRUE; } else if (popupAnchor == POPUPALIGNMENT_BOTTOMLEFT && popupAlign == POPUPALIGNMENT_BOTTOMRIGHT) { *ioXPos -= mRect.width; *ioYPos -= (mRect.height - inParentSize.height); } else if (popupAnchor == POPUPALIGNMENT_BOTTOMLEFT && popupAlign == POPUPALIGNMENT_TOPLEFT) { *ioYPos += inParentSize.height; *outFlushWithTopBottom = PR_TRUE; } else NS_WARNING ( "Hmmm, looks like you've hit a anchor/align case we weren't setup for." ); } // AdjustPositionForAnchorAlign // // IsMoreRoomOnOtherSideOfParent // // Determine if there is more room on the screen for the popup to live if it was positioned // on the flip side of the parent from the side it is flush against (ie, if it's top edge was // flush against the bottom, is there more room if its bottom edge were flush against the top) // PRBool nsMenuPopupFrame::IsMoreRoomOnOtherSideOfParent ( PRBool inFlushAboveBelow, PRInt32 inScreenViewLocX, PRInt32 inScreenViewLocY, const nsRect & inScreenParentFrameRect, PRInt32 inScreenTopTwips, PRInt32 inScreenLeftTwips, PRInt32 inScreenBottomTwips, PRInt32 inScreenRightTwips ) { PRBool switchSides = PR_FALSE; if ( inFlushAboveBelow ) { PRInt32 availAbove = inScreenParentFrameRect.y - inScreenTopTwips; PRInt32 availBelow = inScreenBottomTwips - (inScreenParentFrameRect.y + inScreenParentFrameRect.height) ; if ( inScreenViewLocY > inScreenParentFrameRect.y ) // view is now below parent switchSides = availAbove > availBelow; else switchSides = availBelow > availAbove; } else { PRInt32 availLeft = inScreenParentFrameRect.x - inScreenLeftTwips; PRInt32 availRight = inScreenRightTwips - (inScreenParentFrameRect.x + inScreenParentFrameRect.width) ; if ( inScreenViewLocX > inScreenParentFrameRect.x ) // view is now to the right of parent switchSides = availLeft > availRight; else switchSides = availRight > availLeft; } return switchSides; } // IsMoreRoomOnOtherSideOfParent // // MovePopupToOtherSideOfParent // // Move the popup to the other side of the parent (ie, if it the popup's top edge is flush against the // bottom of its parent, move the popup so that its bottom edge is now flush against the top of its // parent...same idea for left/right). // // NOTE: In moving the popup, it may need to change size in order to stay on the screen. This will // have the side effect of touching |mRect|. // void nsMenuPopupFrame::MovePopupToOtherSideOfParent ( PRBool inFlushAboveBelow, PRInt32* ioXPos, PRInt32* ioYPos, PRInt32* ioScreenViewLocX, PRInt32* ioScreenViewLocY, const nsRect & inScreenParentFrameRect, PRInt32 inScreenTopTwips, PRInt32 inScreenLeftTwips, PRInt32 inScreenBottomTwips, PRInt32 inScreenRightTwips ) { if ( inFlushAboveBelow ) { if ( *ioScreenViewLocY > inScreenParentFrameRect.y ) { // view is currently below parent // move it above. PRInt32 shiftDistY = inScreenParentFrameRect.height + mRect.height; *ioYPos -= shiftDistY; *ioScreenViewLocY -= shiftDistY; // trim it to fit. if ( *ioScreenViewLocY < inScreenTopTwips ) { PRInt32 trimY = inScreenTopTwips - *ioScreenViewLocY; *ioYPos += trimY; *ioScreenViewLocY += trimY; mRect.height -= trimY; } } else { // view is currently above parent // move it below PRInt32 shiftDistY = inScreenParentFrameRect.height + mRect.height; *ioYPos += shiftDistY; *ioScreenViewLocY += shiftDistY; } } else { if ( *ioScreenViewLocX > inScreenParentFrameRect.x ) { // view is currently to the right of the parent // move it to the left. PRInt32 shiftDistX = inScreenParentFrameRect.width + mRect.width; *ioXPos -= shiftDistX; *ioScreenViewLocX -= shiftDistX; // trim it to fit. if ( *ioScreenViewLocX < inScreenLeftTwips ) { PRInt32 trimX = inScreenLeftTwips - *ioScreenViewLocX; *ioXPos += trimX; *ioScreenViewLocX += trimX; mRect.width -= trimX; } } else { // view is currently to the right of the parent // move it to the right PRInt32 shiftDistX = inScreenParentFrameRect.width + mRect.width; *ioXPos += shiftDistX; *ioScreenViewLocX += shiftDistX; } } } // MovePopupToOtherSideOfParent // XXXndeakin this function will be reworked in bug 384062 such that positioning // of the popup is done only when the popup is first opened, so that the popup doesn't // move around when it is changed in some way. nsresult nsMenuPopupFrame::SetPopupPosition(nsIFrame* aAnchorFrame) { if (!mShouldAutoPosition && !mInContentShell) return NS_OK; PRBool sizedToPopup = PR_FALSE; nsPresContext* presContext = PresContext(); nsIFrame* rootFrame = presContext->PresShell()->FrameManager()->GetRootFrame(); NS_ASSERTION(rootFrame->GetView() && GetView() && rootFrame->GetView() == GetView()->GetParent(), "rootFrame's view is not our view's parent???"); // if the frame is not specified, use the anchor node passed to ShowPopup. If // that wasn't specified either, use the root frame. Note that mAnchorContent // might be a different document so its presshell must be used. if (!aAnchorFrame) { if (mAnchorContent) { nsCOMPtr document = mAnchorContent->GetDocument(); if (document) { nsIPresShell *shell = document->GetPrimaryShell(); if (!shell) return NS_ERROR_FAILURE; aAnchorFrame = shell->GetPrimaryFrameFor(mAnchorContent); } } if (!aAnchorFrame) { aAnchorFrame = rootFrame; if (!aAnchorFrame) return NS_OK; } } if (aAnchorFrame->GetContent()) { // the popup should be the same size as the anchor menu, for example, a menulist. sizedToPopup = nsMenuFrame::IsSizedToPopup(aAnchorFrame->GetContent(), PR_FALSE); } // |ParentSize| // The dimensions of the anchor in its app units nsSize parentSize = aAnchorFrame->GetSize(); // the anchor may be in a different document with a different scale, // so adjust the size so that it is in the app units of the popup instead // of the anchor. This is done by converting to device pixels by dividing // by the anchor's app units per device pixel and then converting back to // app units by multiplying by the popup's app units per device pixel. float adj = float(presContext->AppUnitsPerDevPixel()) / aAnchorFrame->PresContext()->AppUnitsPerDevPixel(); parentSize.width = NSToCoordCeil(parentSize.width * adj); parentSize.height = NSToCoordCeil(parentSize.height * adj); // Set the popup's size to the preferred size. Below, this size will be // adjusted to fit on the screen or within the content area. If the anchor // is sized to the popup, use the anchor's width instead of the preferred // width. The preferred size should already be set by the parent frame. NS_ASSERTION(mPrefSize.width >= 0 || mPrefSize.height >= 0, "preferred size of popup not set"); if (sizedToPopup) { mRect.width = parentSize.width; } else { mRect.width = mPrefSize.width; } mRect.height = mPrefSize.height; // |xpos| and |ypos| hold the x and y positions of where the popup will be moved to, // in app units, in the coordinate system of the _parent view_. PRBool readjustAboveBelow = PR_FALSE; PRInt32 xpos = 0, ypos = 0; nsMargin margin; // the positon in app units where the popup should appear. PRInt32 screenViewLocX, screenViewLocY; // the screen rectangle of the anchor, or if null, the root frame, in dev pixels. nsRect anchorScreenRect; nsRect rootScreenRect = rootFrame->GetScreenRectInAppUnits(); nsIDeviceContext* devContext = PresContext()->DeviceContext(); nscoord offsetForContextMenu = 0; if (mScreenXPos == -1 && mScreenYPos == -1) { // if we are anchored to our parent, there are certain things we don't want to do // when repositioning the view to fit on the screen, such as end up positioned over // the parent. When doing this reposition, we want to move the popup to the side with // the most room. The combination of anchor and alignment dictate if we readjust // above/below or to the left/right. if (mAnchorContent) { anchorScreenRect = aAnchorFrame->GetScreenRectInAppUnits(); // adjust for differences in the anchor frame's scaling anchorScreenRect.ScaleRoundOut(adj); xpos = anchorScreenRect.x - rootScreenRect.x; ypos = anchorScreenRect.y - rootScreenRect.y; // move the popup according to the anchor and alignment. This will also tell us // which axis the popup is flush against in case we have to move it around later. AdjustPositionForAnchorAlign(&xpos, &ypos, parentSize, &readjustAboveBelow); } else { // with no anchor, the popup is positioned relative to the root frame anchorScreenRect = rootScreenRect; GetStyleMargin()->GetMargin(margin); xpos = margin.left; ypos = margin.top; } // add on the offset xpos += presContext->CSSPixelsToAppUnits(mXPos); ypos += presContext->CSSPixelsToAppUnits(mYPos); screenViewLocX = rootScreenRect.x + xpos; screenViewLocY = rootScreenRect.y + ypos; } else { // the popup is positioned at a screen coordinate. // first convert the screen position in mScreenXPos and mScreenYPos from // CSS pixels into device pixels, ignoring any scaling as mScreenXPos and // mScreenYPos are unscaled screen coordinates. PRInt32 factor = devContext->UnscaledAppUnitsPerDevPixel(); screenViewLocX = nsPresContext::CSSPixelsToAppUnits(mScreenXPos) / factor; screenViewLocY = nsPresContext::CSSPixelsToAppUnits(mScreenYPos) / factor; if (mAdjustOffsetForContextMenu) { PRInt32 offsetForContextMenuDev = nsPresContext::CSSPixelsToAppUnits(2) / factor; offsetForContextMenu = presContext->DevPixelsToAppUnits(offsetForContextMenuDev); } // next, convert back into app units accounting for the scaling, // and add the margins on the popup GetStyleMargin()->GetMargin(margin); screenViewLocX = presContext->DevPixelsToAppUnits(screenViewLocX) + margin.left + offsetForContextMenu; screenViewLocY = presContext->DevPixelsToAppUnits(screenViewLocY) + margin.top + offsetForContextMenu; // determine the x and y position by subtracting the desired screen // position from the screen position of the root frame. xpos = screenViewLocX - rootScreenRect.x; ypos = screenViewLocY - rootScreenRect.y; } // Compute info about the screen dimensions. Because of multiple monitor systems, // the left or top sides of the screen may be in negative space (main monitor is on the // right, etc). We need to be sure to do the right thing. nsRect rect; if ( mMenuCanOverlapOSBar ) { devContext->GetRect(rect); } else { devContext->GetClientRect(rect); } // keep 3px margin to the right and bottom of the screen for WinXP dropshadow rect.width -= nsPresContext::CSSPixelsToAppUnits(3); rect.height -= nsPresContext::CSSPixelsToAppUnits(3); // for content shells, clip to the client area rather than the screen area if (mInContentShell) { rect.IntersectRect(rect, rootScreenRect); } PRInt32 screenLeftTwips = rect.x; PRInt32 screenTopTwips = rect.y; PRInt32 screenWidthTwips = rect.width; PRInt32 screenHeightTwips = rect.height; PRInt32 screenRightTwips = rect.XMost(); PRInt32 screenBottomTwips = rect.YMost(); if (mPopupAnchor != POPUPALIGNMENT_NONE && mScreenXPos == -1 && mScreenYPos == -1) { // // Popup is anchored to the parent, guarantee that it does not cover the parent. We // shouldn't do anything funky if it will already fit on the screen as is. // /////////////////////////////////////////////////////////////////////////////// // // +------------------------+ // | /\ | // parentPos -> - +------------------------+ // | | | // offset | | | // | | | // | | | (screenViewLocX,screenViewLocY) // - |========================|+-------------- // | parentSize > || // |========================|| // | || Submenu // +------------------------+| ( = mRect ) // | \/ || // +------------------------+ // Don't let it spill off the screen to the top if (screenViewLocY < screenTopTwips) { PRInt32 moveDist = screenTopTwips - screenViewLocY; screenViewLocY = screenTopTwips; ypos += moveDist; } // if it doesn't fit on the screen, do our magic. if ( (screenViewLocX + mRect.width) > screenRightTwips || screenViewLocX < screenLeftTwips || (screenViewLocY + mRect.height) > screenBottomTwips ) { nsRect screenParentFrameRect(anchorScreenRect); // figure out which side of the parent has the most free space so we can move/resize // the popup there. This should still work if the parent frame is partially screen. PRBool switchSides = IsMoreRoomOnOtherSideOfParent ( readjustAboveBelow, screenViewLocX, screenViewLocY, screenParentFrameRect, screenTopTwips, screenLeftTwips, screenBottomTwips, screenRightTwips ); // move the popup to the correct side, if necessary. Note that MovePopupToOtherSideOfParent() // can change width/height of |mRect|. if ( switchSides ) MovePopupToOtherSideOfParent ( readjustAboveBelow, &xpos, &ypos, &screenViewLocX, &screenViewLocY, screenParentFrameRect, screenTopTwips, screenLeftTwips, screenBottomTwips, screenRightTwips ); // We are allowed to move the popup along the axis to which we're not anchored to the parent // in order to get it to not spill off the screen. if ( readjustAboveBelow ) { // move left to be on screen, but don't let it go off the screen at the left if ( (screenViewLocX + mRect.width) > screenRightTwips ) { PRInt32 moveDistX = (screenViewLocX + mRect.width) - screenRightTwips; if ( screenViewLocX - moveDistX < screenLeftTwips ) moveDistX = screenViewLocX - screenLeftTwips; screenViewLocX -= moveDistX; xpos -= moveDistX; } else if (screenViewLocX < screenLeftTwips) { // move right to be on screen, but don't let it go off the screen at the right PRInt32 moveDistX = screenLeftTwips - screenViewLocX; if ( (screenViewLocX + mRect.width + moveDistX) > screenRightTwips ) moveDistX = screenRightTwips - screenViewLocX - mRect.width; screenViewLocX += moveDistX; xpos += moveDistX; } } else { // move it up to be on screen, but don't let it go off the screen at the top /* * | * | * |+---- screenViewLocY * || * || Submenu ( = mRect ) * -+| * | * | * - - - - - - - - - - screenBottomTwips (bottom of the screen) * | \ * | } moveDistY * | / * +---- screenViewLocY + mRect.height */ if ( (screenViewLocY + mRect.height) > screenBottomTwips ) { PRInt32 moveDistY = (screenViewLocY + mRect.height) - screenBottomTwips; if ( screenViewLocY - moveDistY < screenTopTwips ) moveDistY = screenViewLocY - screenTopTwips; screenViewLocY -= moveDistY; ypos -= moveDistY; } } // Resize it to fit on the screen. By this point, we've given the popup as much // room as we can w/out covering the parent. If it still can't be as big // as it wants to be, well, it just has to suck up and deal. // // ySpillage is calculated the same way as moveDistY above. see picture there. PRInt32 xSpillage = (screenViewLocX + mRect.width) - screenRightTwips; if ( xSpillage > 0 ) mRect.width -= xSpillage; PRInt32 ySpillage = (screenViewLocY + mRect.height) - screenBottomTwips; if ( ySpillage > 0 ) mRect.height -= ySpillage; // shrink to fit onto the screen, vertically and horizontally if(mRect.width > screenWidthTwips) mRect.width = screenWidthTwips; if(mRect.height > screenHeightTwips) mRect.height = screenHeightTwips; } // if it doesn't fit on screen } // if anchored to parent else { // // Popup not anchored to anything, just make sure it's on the screen by any // means necessary // // If you decide to mess with this code in some way other than just // converting it to be just like the anchored codepath, please make sure to // not regress bug 120226, bug 172530, bug 245163. // XXXbz this is really silly. We should be able to anchor popups to a // point or rect, not a frame, and we should be doing so with context // menus. Furthermore, we should not be adding in pixels manually to // adjust position (in XULPopupListenerImpl::LaunchPopup comes to mind, // though ConvertPosition in the same file has some 21-px bogosity in the // y-direction too). // shrink to fit onto the screen, vertically and horizontally if(mRect.width > screenWidthTwips) mRect.width = screenWidthTwips; if(mRect.height > screenHeightTwips) mRect.height = screenHeightTwips; // First, adjust the X position. For the X position, we slide the popup // left or right as needed to get it on screen. if ( screenViewLocX < screenLeftTwips ) { PRInt32 moveDistX = screenLeftTwips - screenViewLocX; xpos += moveDistX; screenViewLocX += moveDistX; } if ( (screenViewLocX + mRect.width) > screenRightTwips ) xpos -= (screenViewLocX + mRect.width) - screenRightTwips; // Now the Y position. If the popup is up too high, slide it down so it's // on screen. This can't make the popup overlap screenViewLocX/Y since // we're moving it down away from screenViewLocY. if ( screenViewLocY < screenTopTwips ) { PRInt32 moveDistY = screenTopTwips - screenViewLocY; ypos += moveDistY; screenViewLocY += moveDistY; } // Now if the popup extends down too far, either resize it or flip it to be // above the anchor point and resize it to fit above, depending on where we // have more room. But ensure it doesn't overlap screenViewLocX/Y. if ( (screenViewLocY + mRect.height) > screenBottomTwips ) { // XXXbz it'd be good to make use of IsMoreRoomOnOtherSideOfParent and // such here, but that's really focused on having a nonempty parent // rect... if (screenBottomTwips - screenViewLocY > screenViewLocY - screenTopTwips) { // More space below our desired point. Resize to fit in this space. // Note that this is making mRect smaller; othewise we would not have // reached this code. mRect.height = screenBottomTwips - screenViewLocY; } else { // More space above our desired point. Flip and resize to fit in this // space. // First figure out where the bottom of the popup is going to be. nscoord newBottomY = screenViewLocY - 2*offsetForContextMenu - margin.TopBottom(); // Make sure the bottom is on the screen newBottomY = PR_MIN(newBottomY, screenBottomTwips); newBottomY = PR_MAX(newBottomY, screenTopTwips); if (mRect.height > newBottomY - screenTopTwips) { // We wouldn't fit. Shorten before flipping. mRect.height = newBottomY - screenTopTwips; } // Adjust ypos to match ypos += newBottomY - screenViewLocY - mRect.height; } } } presContext->GetViewManager()->MoveViewTo(GetView(), xpos, ypos); // Now that we've positioned the view, sync up the frame's origin. // Note that (xpos,ypos) is the position relative to rootFrame. nsBoxFrame::SetPosition(nsPoint(xpos, ypos) - GetParent()->GetOffsetTo(rootFrame)); if (sizedToPopup) { nsBoxLayoutState state(PresContext()); SetBounds(state, nsRect(mRect.x, mRect.y, parentSize.width, mRect.height)); } return NS_OK; } /* virtual */ nsMenuFrame* nsMenuPopupFrame::GetCurrentMenuItem() { return mCurrentMenu; } PRBool nsMenuPopupFrame::ConsumeOutsideClicks() { // If the popup has explicitly set a consume mode, honor that. if (mConsumeRollupEvent != nsIPopupBoxObject::ROLLUP_DEFAULT) return (mConsumeRollupEvent == nsIPopupBoxObject::ROLLUP_CONSUME); nsCOMPtr parentContent = mContent->GetParent(); if (parentContent) { nsINodeInfo *ni = parentContent->NodeInfo(); if (ni->Equals(nsGkAtoms::menulist, kNameSpaceID_XUL)) return PR_TRUE; // Consume outside clicks for combo boxes on all platforms #if defined(XP_WIN) || defined(XP_OS2) // Don't consume outside clicks for menus in Windows if (ni->Equals(nsGkAtoms::menu, kNameSpaceID_XUL) || (ni->Equals(nsGkAtoms::popupset, kNameSpaceID_XUL))) return PR_FALSE; #endif if (ni->Equals(nsGkAtoms::textbox, kNameSpaceID_XUL)) { // Don't consume outside clicks for autocomplete widget if (parentContent->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type, nsGkAtoms::autocomplete, eCaseMatters)) return PR_FALSE; } } return PR_TRUE; } static nsIScrollableView* GetScrollableViewForFrame(nsIFrame* aFrame) { nsIScrollableFrame* sf; nsresult rv = CallQueryInterface(aFrame, &sf); if (NS_FAILED(rv)) return nsnull; return sf->GetScrollableView(); } // XXXroc this is megalame. Fossicking around for a view of the right // type is a recipe for disaster in the long term. nsIScrollableView* nsMenuPopupFrame::GetScrollableView(nsIFrame* aStart) { if ( ! aStart ) return nsnull; nsIFrame* currFrame; nsIScrollableView* scrollableView=nsnull; // try start frame and siblings currFrame=aStart; do { scrollableView = GetScrollableViewForFrame(currFrame); if ( scrollableView ) return scrollableView; currFrame = currFrame->GetNextSibling(); } while ( currFrame ); // try children nsIFrame* childFrame; currFrame=aStart; do { childFrame = currFrame->GetFirstChild(nsnull); scrollableView=GetScrollableView(childFrame); if ( scrollableView ) return scrollableView; currFrame = currFrame->GetNextSibling(); } while ( currFrame ); return nsnull; } void nsMenuPopupFrame::EnsureMenuItemIsVisible(nsMenuFrame* aMenuItem) { if (aMenuItem) { nsIFrame* childFrame = GetFirstChild(nsnull); nsIScrollableView *scrollableView; scrollableView = GetScrollableView(childFrame); if (scrollableView) { nscoord scrollX, scrollY; nsRect viewRect = scrollableView->View()->GetBounds(); nsRect itemRect = aMenuItem->GetRect(); scrollableView->GetScrollPosition(scrollX, scrollY); // scroll down if ( itemRect.y + itemRect.height > scrollY + viewRect.height ) scrollableView->ScrollTo(scrollX, itemRect.y + itemRect.height - viewRect.height, NS_SCROLL_PROPERTY_ALWAYS_BLIT); // scroll up else if ( itemRect.y < scrollY ) scrollableView->ScrollTo(scrollX, itemRect.y, NS_SCROLL_PROPERTY_ALWAYS_BLIT); } } } NS_IMETHODIMP nsMenuPopupFrame::SetCurrentMenuItem(nsMenuFrame* aMenuItem) { if (mCurrentMenu == aMenuItem) return NS_OK; if (mCurrentMenu) { mCurrentMenu->SelectMenu(PR_FALSE); } if (aMenuItem) { EnsureMenuItemIsVisible(aMenuItem); aMenuItem->SelectMenu(PR_TRUE); } mCurrentMenu = aMenuItem; return NS_OK; } void nsMenuPopupFrame::CurrentMenuIsBeingDestroyed() { mCurrentMenu = nsnull; } NS_IMETHODIMP nsMenuPopupFrame::ChangeMenuItem(nsMenuFrame* aMenuItem, PRBool aSelectFirstItem) { if (mCurrentMenu == aMenuItem) return NS_OK; // When a context menu is open, the current menu is locked, and no change // to the menu is allowed. nsXULPopupManager* pm = nsXULPopupManager::GetInstance(); if (!mIsContextMenu && pm && pm->HasContextMenu(this)) return NS_OK; // Unset the current child. if (mCurrentMenu) { mCurrentMenu->SelectMenu(PR_FALSE); nsMenuPopupFrame* popup = mCurrentMenu->GetPopup(); if (popup) { if (mCurrentMenu->IsOpen()) { if (pm) pm->HidePopupAfterDelay(popup); } } } // Set the new child. if (aMenuItem) { EnsureMenuItemIsVisible(aMenuItem); aMenuItem->SelectMenu(PR_TRUE); } mCurrentMenu = aMenuItem; return NS_OK; } nsMenuFrame* nsMenuPopupFrame::Enter() { mIncrementalString.Truncate(); // Give it to the child. if (mCurrentMenu) return mCurrentMenu->Enter(); return nsnull; } nsMenuFrame* nsMenuPopupFrame::FindMenuWithShortcut(nsIDOMKeyEvent* aKeyEvent, PRBool& doAction) { PRUint32 charCode, keyCode; aKeyEvent->GetCharCode(&charCode); aKeyEvent->GetKeyCode(&keyCode); doAction = PR_FALSE; // Enumerate over our list of frames. nsIFrame* immediateParent = nsnull; PresContext()->PresShell()-> FrameConstructor()->GetInsertionPoint(this, nsnull, &immediateParent); if (!immediateParent) immediateParent = this; PRUint32 matchCount = 0, matchShortcutCount = 0; PRBool foundActive = PR_FALSE; PRBool isShortcut; nsMenuFrame* frameBefore = nsnull; nsMenuFrame* frameAfter = nsnull; nsMenuFrame* frameShortcut = nsnull; nsIContent* parentContent = mContent->GetParent(); PRBool isMenu = parentContent && !parentContent->NodeInfo()->Equals(nsGkAtoms::menulist, kNameSpaceID_XUL); static DOMTimeStamp lastKeyTime = 0; DOMTimeStamp keyTime; aKeyEvent->GetTimeStamp(&keyTime); if (charCode == 0) { if (keyCode == NS_VK_BACK) { if (!isMenu && !mIncrementalString.IsEmpty()) { mIncrementalString.SetLength(mIncrementalString.Length() - 1); return nsnull; } else { #ifdef XP_WIN nsCOMPtr soundInterface = do_CreateInstance("@mozilla.org/sound;1"); if (soundInterface) soundInterface->Beep(); #endif // #ifdef XP_WIN } } return nsnull; } else { PRUnichar uniChar = ToLowerCase(static_cast(charCode)); if (isMenu || // Menu supports only first-letter navigation keyTime - lastKeyTime > INC_TYP_INTERVAL) // Interval too long, treat as new typing mIncrementalString = uniChar; else { mIncrementalString.Append(uniChar); } } // See bug 188199 & 192346, if all letters in incremental string are same, just try to match the first one nsAutoString incrementalString(mIncrementalString); PRUint32 charIndex = 1, stringLength = incrementalString.Length(); while (charIndex < stringLength && incrementalString[charIndex] == incrementalString[charIndex - 1]) { charIndex++; } if (charIndex == stringLength) { incrementalString.Truncate(1); stringLength = 1; } lastKeyTime = keyTime; nsIFrame* currFrame; // NOTE: If you crashed here due to a bogus |immediateParent| it is // possible that the menu whose shortcut is being looked up has // been destroyed already. One strategy would be to // setTimeout(,0) as detailed in: // currFrame = immediateParent->GetFirstChild(nsnull); PRInt32 menuAccessKey = -1; nsMenuBarListener::GetMenuAccessKey(&menuAccessKey); // We start searching from first child. This process is divided into two parts // -- before current and after current -- by the current item while (currFrame) { nsIContent* current = currFrame->GetContent(); // See if it's a menu item. if (nsXULPopupManager::IsValidMenuItem(PresContext(), current, PR_TRUE)) { nsAutoString textKey; if (menuAccessKey >= 0) { // Get the shortcut attribute. current->GetAttr(kNameSpaceID_None, nsGkAtoms::accesskey, textKey); } if (textKey.IsEmpty()) { // No shortcut, try first letter isShortcut = PR_FALSE; current->GetAttr(kNameSpaceID_None, nsGkAtoms::label, textKey); if (textKey.IsEmpty()) // No label, try another attribute (value) current->GetAttr(kNameSpaceID_None, nsGkAtoms::value, textKey); } else isShortcut = PR_TRUE; if (StringBeginsWith(textKey, incrementalString, nsCaseInsensitiveStringComparator())) { // mIncrementalString is a prefix of textKey if (currFrame->GetType() == nsGkAtoms::menuFrame) { // There is one match matchCount++; if (isShortcut) { // There is one shortcut-key match matchShortcutCount++; // Record the matched item. If there is only one matched shortcut item, do it frameShortcut = static_cast(currFrame); } if (!foundActive) { // It's a first candidate item located before/on the current item if (!frameBefore) frameBefore = static_cast(currFrame); } else { // It's a first candidate item located after the current item if (!frameAfter) frameAfter = static_cast(currFrame); } } else return nsnull; } // Get the active status if (current->AttrValueIs(kNameSpaceID_None, nsGkAtoms::menuactive, nsGkAtoms::_true, eCaseMatters)) { foundActive = PR_TRUE; if (stringLength > 1) { // If there is more than one char typed, the current item has highest priority, // otherwise the item next to current has highest priority if (currFrame == frameBefore) return frameBefore; } } } currFrame = currFrame->GetNextSibling(); } doAction = (isMenu && (matchCount == 1 || matchShortcutCount == 1)); if (matchShortcutCount == 1) // We have one matched shortcut item return frameShortcut; if (frameAfter) // If we have matched item after the current, use it return frameAfter; else if (frameBefore) // If we haven't, use the item before the current return frameBefore; // If we don't match anything, rollback the last typing mIncrementalString.SetLength(mIncrementalString.Length() - 1); // didn't find a matching menu item #ifdef XP_WIN // behavior on Windows - this item is in a menu popup off of the // menu bar, so beep and do nothing else if (isMenu) { nsCOMPtr soundInterface = do_CreateInstance("@mozilla.org/sound;1"); if (soundInterface) soundInterface->Beep(); } #endif // #ifdef XP_WIN return nsnull; } NS_IMETHODIMP nsMenuPopupFrame::GetWidget(nsIWidget **aWidget) { nsIView * view = GetRootViewForPopup(this); if (!view) return NS_OK; *aWidget = view->GetWidget(); NS_IF_ADDREF(*aWidget); return NS_OK; } void nsMenuPopupFrame::AttachedDismissalListener() { mConsumeRollupEvent = nsIPopupBoxObject::ROLLUP_DEFAULT; } // helpers ///////////////////////////////////////////////////////////// NS_IMETHODIMP nsMenuPopupFrame::AttributeChanged(PRInt32 aNameSpaceID, nsIAtom* aAttribute, PRInt32 aModType) { nsresult rv = nsBoxFrame::AttributeChanged(aNameSpaceID, aAttribute, aModType); if (aAttribute == nsGkAtoms::left || aAttribute == nsGkAtoms::top) MoveToAttributePosition(); // accessibility needs this to ensure the frames get constructed when the // menugenerated attribute is set, see bug 279703 comment 42 for discussion if (aAttribute == nsGkAtoms::menugenerated && mFrames.IsEmpty() && !mGeneratedChildren) { PresContext()->PresShell()->FrameConstructor()-> AddLazyChildren(mContent, LazyGeneratePopupDone, nsnull, PR_TRUE); } return rv; } void nsMenuPopupFrame::MoveToAttributePosition() { // Move the widget around when the user sets the |left| and |top| attributes. // Note that this is not the best way to move the widget, as it results in lots // of FE notifications and is likely to be slow as molasses. Use |moveTo| on // nsIPopupBoxObject if possible. nsAutoString left, top; mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::left, left); mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::top, top); PRInt32 err1, err2; mScreenXPos = left.ToInteger(&err1); mScreenYPos = top.ToInteger(&err2); if (NS_SUCCEEDED(err1) && NS_SUCCEEDED(err2)) MoveToInternal(mScreenXPos, mScreenYPos); } void nsMenuPopupFrame::Destroy() { nsXULPopupManager* pm = nsXULPopupManager::GetInstance(); if (pm) pm->PopupDestroyed(this); nsBoxFrame::Destroy(); } void nsMenuPopupFrame::MoveTo(PRInt32 aLeft, PRInt32 aTop) { // Set the 'left' and 'top' attributes nsAutoString left, top; left.AppendInt(aLeft); top.AppendInt(aTop); nsWeakFrame weakFrame(this); mContent->SetAttr(kNameSpaceID_None, nsGkAtoms::left, left, PR_FALSE); if (!weakFrame.IsAlive()) { return; } mContent->SetAttr(kNameSpaceID_None, nsGkAtoms::top, top, PR_FALSE); if (!weakFrame.IsAlive()) { return; } MoveToInternal(aLeft, aTop); } void nsMenuPopupFrame::MoveToInternal(PRInt32 aLeft, PRInt32 aTop) { // just don't support moving popups for content shells if (mInContentShell) return; nsIView* view = GetView(); NS_ASSERTION(view->GetParent(), "Must have parent!"); // Retrieve screen position of parent view nsIntPoint screenPos = view->GetParent()->GetScreenPosition(); nsPresContext* context = PresContext(); aLeft = context->AppUnitsToDevPixels(nsPresContext::CSSPixelsToAppUnits(aLeft)); aTop = context->AppUnitsToDevPixels(nsPresContext::CSSPixelsToAppUnits(aTop)); // Move the widget. The widget will be null if it hasn't been created yet, // but that's OK as the popup won't be open in this case. // XXXbz don't we want screenPos to be the parent _widget_'s position, then? nsIWidget* widget = view->GetWidget(); if (widget) widget->Move(aLeft - screenPos.x, aTop - screenPos.y); } PRBool nsMenuPopupFrame::GetAutoPosition() { return mShouldAutoPosition; } void nsMenuPopupFrame::SetAutoPosition(PRBool aShouldAutoPosition) { mShouldAutoPosition = aShouldAutoPosition; } void nsMenuPopupFrame::SetConsumeRollupEvent(PRUint32 aConsumeMode) { mConsumeRollupEvent = aConsumeMode; }