/* ============================================================================== This file is part of the JUCE framework. Copyright (c) Raw Material Software Limited JUCE is an open source framework subject to commercial or open source licensing. By downloading, installing, or using the JUCE framework, or combining the JUCE framework with any other source code, object code, content or any other copyrightable work, you agree to the terms of the JUCE End User Licence Agreement, and all incorporated terms including the JUCE Privacy Policy and the JUCE Website Terms of Service, as applicable, which will bind you. If you do not agree to the terms of these agreements, we will not license the JUCE framework to you, and you must discontinue the installation or download process and cease use of the JUCE framework. JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/ JUCE Privacy Policy: https://juce.com/juce-privacy-policy JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/ Or: You may also use this code under the terms of the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.en.html THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED. ============================================================================== */ namespace juce { SidePanel::SidePanel (StringRef title, int width, bool positionOnLeft, Component* contentToDisplay, bool deleteComponentWhenNoLongerNeeded) : titleLabel ("titleLabel", title), isOnLeft (positionOnLeft), panelWidth (width) { lookAndFeelChanged(); addAndMakeVisible (titleLabel); dismissButton.onClick = [this] { showOrHide (false); }; addAndMakeVisible (dismissButton); auto& desktop = Desktop::getInstance(); desktop.addGlobalMouseListener (this); desktop.getAnimator().addChangeListener (this); if (contentToDisplay != nullptr) setContent (contentToDisplay, deleteComponentWhenNoLongerNeeded); setOpaque (false); setVisible (false); setAlwaysOnTop (true); } SidePanel::~SidePanel() { auto& desktop = Desktop::getInstance(); desktop.removeGlobalMouseListener (this); desktop.getAnimator().removeChangeListener (this); if (parent != nullptr) parent->removeComponentListener (this); } void SidePanel::setContent (Component* newContent, bool deleteComponentWhenNoLongerNeeded) { if (contentComponent.get() != newContent) { if (deleteComponentWhenNoLongerNeeded) contentComponent.setOwned (newContent); else contentComponent.setNonOwned (newContent); addAndMakeVisible (contentComponent); resized(); } } void SidePanel::setTitleBarComponent (Component* titleBarComponentToUse, bool keepDismissButton, bool deleteComponentWhenNoLongerNeeded) { if (titleBarComponent.get() != titleBarComponentToUse) { if (deleteComponentWhenNoLongerNeeded) titleBarComponent.setOwned (titleBarComponentToUse); else titleBarComponent.setNonOwned (titleBarComponentToUse); addAndMakeVisible (titleBarComponent); resized(); } shouldShowDismissButton = keepDismissButton; } void SidePanel::showOrHide (bool show) { if (parent != nullptr) { isShowing = show; Desktop::getInstance().getAnimator().animateComponent (this, calculateBoundsInParent (*parent), 1.0f, 250, true, 1.0, 0.0); if (isShowing && ! isVisible()) setVisible (true); } } void SidePanel::moved() { NullCheckedInvocation::invoke (onPanelMove); } void SidePanel::resized() { auto bounds = getLocalBounds(); calculateAndRemoveShadowBounds (bounds); const auto fullScreen = std::invoke ([&] { if (auto* peer = getPeer()) return peer->isFullScreen(); return false; }); if (fullScreen && isContentRestrictedToSafeArea() && parent != nullptr) { if (auto* display = Desktop::getInstance().getDisplays().getDisplayForRect (parent->getScreenBounds())) { const auto safeArea = display->safeAreaInsets.subtractedFrom (display->keyboardInsets.subtractedFrom (display->userArea)); const auto safeAreaInLocalSpace = getLocalArea (nullptr, safeArea) + getCurrentOffset(); bounds = bounds.getIntersection (safeAreaInLocalSpace); } } auto titleBounds = bounds.removeFromTop (titleBarHeight); if (titleBarComponent != nullptr) { if (shouldShowDismissButton) dismissButton.setBounds (isOnLeft ? titleBounds.removeFromRight (30).withTrimmedRight (10) : titleBounds.removeFromLeft (30).withTrimmedLeft (10)); titleBarComponent->setBounds (titleBounds); } else { dismissButton.setBounds (isOnLeft ? titleBounds.removeFromRight (30).withTrimmedRight (10) : titleBounds.removeFromLeft (30).withTrimmedLeft (10)); titleLabel.setBounds (isOnLeft ? titleBounds.withTrimmedRight (40) : titleBounds.withTrimmedLeft (40)); } if (contentComponent != nullptr) contentComponent->setBounds (bounds); } void SidePanel::paint (Graphics& g) { auto& lf = getLookAndFeel(); auto bgColour = lf.findColour (SidePanel::backgroundColour); auto shadowColour = lf.findColour (SidePanel::shadowBaseColour); g.setGradientFill (ColourGradient (shadowColour.withAlpha (0.7f), (isOnLeft ? shadowArea.getTopLeft() : shadowArea.getTopRight()).toFloat(), shadowColour.withAlpha (0.0f), (isOnLeft ? shadowArea.getTopRight() : shadowArea.getTopLeft()).toFloat(), false)); g.fillRect (shadowArea); g.reduceClipRegion (getLocalBounds().withTrimmedRight (shadowArea.getWidth()) .withX (isOnLeft ? 0 : shadowArea.getWidth())); g.fillAll (bgColour); } void SidePanel::parentHierarchyChanged() { auto* newParent = getParentComponent(); if ((newParent != nullptr) && (parent != newParent)) { if (parent != nullptr) parent->removeComponentListener (this); parent = newParent; parent->addComponentListener (this); } } void SidePanel::mouseDrag (const MouseEvent& e) { if (shouldResize) { Point convertedPoint; if (getParentComponent() == nullptr) convertedPoint = e.eventComponent->localPointToGlobal (e.getPosition()); else convertedPoint = getParentComponent()->getLocalPoint (e.eventComponent, e.getPosition()); auto currentMouseDragX = convertedPoint.x; if (isOnLeft) { amountMoved = startingBounds.getRight() - currentMouseDragX; setBounds (getBounds().withX (startingBounds.getX() - jmax (amountMoved, 0))); } else { amountMoved = currentMouseDragX - startingBounds.getX(); setBounds (getBounds().withX (startingBounds.getX() + jmax (amountMoved, 0))); } } else if (isShowing) { auto relativeMouseDownPosition = getLocalPoint (e.eventComponent, e.getMouseDownPosition()); auto relativeMouseDragPosition = getLocalPoint (e.eventComponent, e.getPosition()); if (! getLocalBounds().contains (relativeMouseDownPosition) && getLocalBounds().contains (relativeMouseDragPosition)) { shouldResize = true; startingBounds = getBounds(); } } } void SidePanel::mouseUp (const MouseEvent&) { if (shouldResize) { showOrHide (amountMoved < (panelWidth / 2)); amountMoved = 0; shouldResize = false; } } //============================================================================== void SidePanel::lookAndFeelChanged() { auto& lf = getLookAndFeel(); dismissButton.setShape (lf.getSidePanelDismissButtonShape (*this), false, true, false); dismissButton.setColours (lf.findColour (SidePanel::dismissButtonNormalColour), lf.findColour (SidePanel::dismissButtonOverColour), lf.findColour (SidePanel::dismissButtonDownColour)); titleLabel.setFont (lf.getSidePanelTitleFont (*this)); titleLabel.setColour (Label::textColourId, findColour (SidePanel::titleTextColour)); titleLabel.setJustificationType (lf.getSidePanelTitleJustification (*this)); } void SidePanel::componentMovedOrResized (Component& component, [[maybe_unused]] bool wasMoved, bool wasResized) { if (wasResized && (&component == parent)) setBounds (calculateBoundsInParent (component)); } void SidePanel::changeListenerCallback (ChangeBroadcaster*) { if (! Desktop::getInstance().getAnimator().isAnimating (this)) { NullCheckedInvocation::invoke (onPanelShowHide, isShowing); if (isVisible() && ! isShowing) setVisible (false); } } Rectangle SidePanel::calculateShowingBoundsInParent (Component& parentComp) const { auto parentBounds = parentComp.getLocalBounds(); return isOnLeft ? parentBounds.removeFromLeft (panelWidth) : parentBounds.removeFromRight (panelWidth); } Point SidePanel::getCurrentOffset() const { if (isShowing) return {}; return { isOnLeft ? -panelWidth : panelWidth, 0 }; } Rectangle SidePanel::calculateBoundsInParent (Component& parentComp) const { return calculateShowingBoundsInParent (parentComp) + getCurrentOffset(); } void SidePanel::calculateAndRemoveShadowBounds (Rectangle& bounds) { shadowArea = isOnLeft ? bounds.removeFromRight (shadowWidth) : bounds.removeFromLeft (shadowWidth); } bool SidePanel::isMouseEventInThisOrChildren (Component* eventComponent) { if (eventComponent == this) return true; for (auto& child : getChildren()) if (eventComponent == child) return true; return false; } //============================================================================== std::unique_ptr SidePanel::createAccessibilityHandler() { return std::make_unique (*this, AccessibilityRole::group); } } // namespace juce