You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
dexed/JuceLibraryCode/modules/juce_gui_basics/layout/juce_MultiDocumentPanel.cpp

507 lines
15 KiB

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2013 - Raw Material Software Ltd.
Permission is granted to use this software under the terms of either:
a) the GPL v2 (or any later version)
b) the Affero GPL v3
Details of these licenses can be found at: www.gnu.org/licenses
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
------------------------------------------------------------------------------
To release a closed-source product which uses JUCE, commercial licenses are
available: visit www.juce.com for more information.
==============================================================================
*/
MultiDocumentPanelWindow::MultiDocumentPanelWindow (Colour backgroundColour)
: DocumentWindow (String::empty, backgroundColour,
DocumentWindow::maximiseButton | DocumentWindow::closeButton, false)
{
}
MultiDocumentPanelWindow::~MultiDocumentPanelWindow()
{
}
//==============================================================================
void MultiDocumentPanelWindow::maximiseButtonPressed()
{
if (MultiDocumentPanel* const owner = getOwner())
owner->setLayoutMode (MultiDocumentPanel::MaximisedWindowsWithTabs);
else
jassertfalse; // these windows are only designed to be used inside a MultiDocumentPanel!
}
void MultiDocumentPanelWindow::closeButtonPressed()
{
if (MultiDocumentPanel* const owner = getOwner())
owner->closeDocument (getContentComponent(), true);
else
jassertfalse; // these windows are only designed to be used inside a MultiDocumentPanel!
}
void MultiDocumentPanelWindow::activeWindowStatusChanged()
{
DocumentWindow::activeWindowStatusChanged();
updateOrder();
}
void MultiDocumentPanelWindow::broughtToFront()
{
DocumentWindow::broughtToFront();
updateOrder();
}
void MultiDocumentPanelWindow::updateOrder()
{
if (MultiDocumentPanel* const owner = getOwner())
owner->updateOrder();
}
MultiDocumentPanel* MultiDocumentPanelWindow::getOwner() const noexcept
{
return findParentComponentOfClass<MultiDocumentPanel>();
}
//==============================================================================
class MultiDocumentPanel::TabbedComponentInternal : public TabbedComponent
{
public:
TabbedComponentInternal()
: TabbedComponent (TabbedButtonBar::TabsAtTop)
{
}
void currentTabChanged (int, const String&)
{
if (MultiDocumentPanel* const owner = findParentComponentOfClass<MultiDocumentPanel>())
owner->updateOrder();
}
};
//==============================================================================
MultiDocumentPanel::MultiDocumentPanel()
: mode (MaximisedWindowsWithTabs),
backgroundColour (Colours::lightblue),
maximumNumDocuments (0),
numDocsBeforeTabsUsed (0)
{
setOpaque (true);
}
MultiDocumentPanel::~MultiDocumentPanel()
{
closeAllDocuments (false);
}
//==============================================================================
namespace MultiDocHelpers
{
static bool shouldDeleteComp (Component* const c)
{
return c->getProperties() ["mdiDocumentDelete_"];
}
}
bool MultiDocumentPanel::closeAllDocuments (const bool checkItsOkToCloseFirst)
{
while (components.size() > 0)
if (! closeDocument (components.getLast(), checkItsOkToCloseFirst))
return false;
return true;
}
MultiDocumentPanelWindow* MultiDocumentPanel::createNewDocumentWindow()
{
return new MultiDocumentPanelWindow (backgroundColour);
}
void MultiDocumentPanel::addWindow (Component* component)
{
MultiDocumentPanelWindow* const dw = createNewDocumentWindow();
dw->setResizable (true, false);
dw->setContentNonOwned (component, true);
dw->setName (component->getName());
const var bkg (component->getProperties() ["mdiDocumentBkg_"]);
dw->setBackgroundColour (bkg.isVoid() ? backgroundColour : Colour ((uint32) static_cast <int> (bkg)));
int x = 4;
if (Component* const topComp = getChildComponent (getNumChildComponents() - 1))
if (topComp->getX() == x && topComp->getY() == x)
x += 16;
dw->setTopLeftPosition (x, x);
const var pos (component->getProperties() ["mdiDocumentPos_"]);
if (pos.toString().isNotEmpty())
dw->restoreWindowStateFromString (pos.toString());
addAndMakeVisible (dw);
dw->toFront (true);
}
bool MultiDocumentPanel::addDocument (Component* const component,
Colour docColour,
const bool deleteWhenRemoved)
{
// If you try passing a full DocumentWindow or ResizableWindow in here, you'll end up
// with a frame-within-a-frame! Just pass in the bare content component.
jassert (dynamic_cast <ResizableWindow*> (component) == nullptr);
if (component == nullptr || (maximumNumDocuments > 0 && components.size() >= maximumNumDocuments))
return false;
components.add (component);
component->getProperties().set ("mdiDocumentDelete_", deleteWhenRemoved);
component->getProperties().set ("mdiDocumentBkg_", (int) docColour.getARGB());
component->addComponentListener (this);
if (mode == FloatingWindows)
{
if (isFullscreenWhenOneDocument())
{
if (components.size() == 1)
{
addAndMakeVisible (component);
}
else
{
if (components.size() == 2)
addWindow (components.getFirst());
addWindow (component);
}
}
else
{
addWindow (component);
}
}
else
{
if (tabComponent == nullptr && components.size() > numDocsBeforeTabsUsed)
{
addAndMakeVisible (tabComponent = new TabbedComponentInternal());
Array <Component*> temp (components);
for (int i = 0; i < temp.size(); ++i)
tabComponent->addTab (temp[i]->getName(), docColour, temp[i], false);
resized();
}
else
{
if (tabComponent != nullptr)
tabComponent->addTab (component->getName(), docColour, component, false);
else
addAndMakeVisible (component);
}
setActiveDocument (component);
}
resized();
activeDocumentChanged();
return true;
}
bool MultiDocumentPanel::closeDocument (Component* component,
const bool checkItsOkToCloseFirst)
{
if (components.contains (component))
{
if (checkItsOkToCloseFirst && ! tryToCloseDocument (component))
return false;
component->removeComponentListener (this);
const bool shouldDelete = MultiDocHelpers::shouldDeleteComp (component);
component->getProperties().remove ("mdiDocumentDelete_");
component->getProperties().remove ("mdiDocumentBkg_");
if (mode == FloatingWindows)
{
for (int i = getNumChildComponents(); --i >= 0;)
{
if (MultiDocumentPanelWindow* const dw = dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)))
{
if (dw->getContentComponent() == component)
{
ScopedPointer<MultiDocumentPanelWindow> (dw)->clearContentComponent();
break;
}
}
}
if (shouldDelete)
delete component;
components.removeFirstMatchingValue (component);
if (isFullscreenWhenOneDocument() && components.size() == 1)
{
for (int i = getNumChildComponents(); --i >= 0;)
{
ScopedPointer<MultiDocumentPanelWindow> dw (dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)));
if (dw != nullptr)
dw->clearContentComponent();
}
addAndMakeVisible (components.getFirst());
}
}
else
{
jassert (components.indexOf (component) >= 0);
if (tabComponent != nullptr)
{
for (int i = tabComponent->getNumTabs(); --i >= 0;)
if (tabComponent->getTabContentComponent (i) == component)
tabComponent->removeTab (i);
}
else
{
removeChildComponent (component);
}
if (shouldDelete)
delete component;
if (tabComponent != nullptr && tabComponent->getNumTabs() <= numDocsBeforeTabsUsed)
tabComponent = nullptr;
components.removeFirstMatchingValue (component);
if (components.size() > 0 && tabComponent == nullptr)
addAndMakeVisible (components.getFirst());
}
resized();
// This ensures that the active tab is painted properly when a tab is closed!
if (Component* activeComponent = getActiveDocument())
setActiveDocument (activeComponent);
activeDocumentChanged();
}
else
{
jassertfalse;
}
return true;
}
int MultiDocumentPanel::getNumDocuments() const noexcept
{
return components.size();
}
Component* MultiDocumentPanel::getDocument (const int index) const noexcept
{
return components [index];
}
Component* MultiDocumentPanel::getActiveDocument() const noexcept
{
if (mode == FloatingWindows)
{
for (int i = getNumChildComponents(); --i >= 0;)
if (MultiDocumentPanelWindow* const dw = dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)))
if (dw->isActiveWindow())
return dw->getContentComponent();
}
return components.getLast();
}
void MultiDocumentPanel::setActiveDocument (Component* component)
{
jassert (component != nullptr);
if (mode == FloatingWindows)
{
component = getContainerComp (component);
if (component != nullptr)
component->toFront (true);
}
else if (tabComponent != nullptr)
{
jassert (components.indexOf (component) >= 0);
for (int i = tabComponent->getNumTabs(); --i >= 0;)
{
if (tabComponent->getTabContentComponent (i) == component)
{
tabComponent->setCurrentTabIndex (i);
break;
}
}
}
else
{
component->grabKeyboardFocus();
}
}
void MultiDocumentPanel::activeDocumentChanged()
{
}
void MultiDocumentPanel::setMaximumNumDocuments (const int newNumber)
{
maximumNumDocuments = newNumber;
}
void MultiDocumentPanel::useFullscreenWhenOneDocument (const bool shouldUseTabs)
{
numDocsBeforeTabsUsed = shouldUseTabs ? 1 : 0;
}
bool MultiDocumentPanel::isFullscreenWhenOneDocument() const noexcept
{
return numDocsBeforeTabsUsed != 0;
}
//==============================================================================
void MultiDocumentPanel::setLayoutMode (const LayoutMode newLayoutMode)
{
if (mode != newLayoutMode)
{
mode = newLayoutMode;
if (mode == FloatingWindows)
{
tabComponent = nullptr;
}
else
{
for (int i = getNumChildComponents(); --i >= 0;)
{
ScopedPointer<MultiDocumentPanelWindow> dw (dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)));
if (dw != nullptr)
{
dw->getContentComponent()->getProperties().set ("mdiDocumentPos_", dw->getWindowStateAsString());
dw->clearContentComponent();
}
}
}
resized();
const Array <Component*> tempComps (components);
components.clear();
for (int i = 0; i < tempComps.size(); ++i)
{
Component* const c = tempComps.getUnchecked(i);
addDocument (c,
Colour ((uint32) static_cast <int> (c->getProperties().getWithDefault ("mdiDocumentBkg_", (int) Colours::white.getARGB()))),
MultiDocHelpers::shouldDeleteComp (c));
}
}
}
void MultiDocumentPanel::setBackgroundColour (Colour newBackgroundColour)
{
if (backgroundColour != newBackgroundColour)
{
backgroundColour = newBackgroundColour;
setOpaque (newBackgroundColour.isOpaque());
repaint();
}
}
//==============================================================================
void MultiDocumentPanel::paint (Graphics& g)
{
g.fillAll (backgroundColour);
}
void MultiDocumentPanel::resized()
{
if (mode == MaximisedWindowsWithTabs || components.size() == numDocsBeforeTabsUsed)
{
for (int i = getNumChildComponents(); --i >= 0;)
getChildComponent (i)->setBounds (getLocalBounds());
}
setWantsKeyboardFocus (components.size() == 0);
}
Component* MultiDocumentPanel::getContainerComp (Component* c) const
{
if (mode == FloatingWindows)
{
for (int i = 0; i < getNumChildComponents(); ++i)
if (MultiDocumentPanelWindow* const dw = dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)))
if (dw->getContentComponent() == c)
return dw;
}
return c;
}
void MultiDocumentPanel::componentNameChanged (Component&)
{
if (mode == FloatingWindows)
{
for (int i = 0; i < getNumChildComponents(); ++i)
if (MultiDocumentPanelWindow* const dw = dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)))
dw->setName (dw->getContentComponent()->getName());
}
else if (tabComponent != nullptr)
{
for (int i = tabComponent->getNumTabs(); --i >= 0;)
tabComponent->setTabName (i, tabComponent->getTabContentComponent (i)->getName());
}
}
void MultiDocumentPanel::updateOrder()
{
const Array <Component*> oldList (components);
if (mode == FloatingWindows)
{
components.clear();
for (int i = 0; i < getNumChildComponents(); ++i)
if (MultiDocumentPanelWindow* const dw = dynamic_cast <MultiDocumentPanelWindow*> (getChildComponent (i)))
components.add (dw->getContentComponent());
}
else
{
if (tabComponent != nullptr)
{
if (Component* const current = tabComponent->getCurrentContentComponent())
{
components.removeFirstMatchingValue (current);
components.add (current);
}
}
}
if (components != oldList)
activeDocumentChanged();
}