A component that contains a set of other components either in floating windows or tabs. More...
Inherits Component, and ComponentListener.
Public Types | |
| enum | LayoutMode { FloatingWindows, MaximisedWindowsWithTabs } |
The different layout modes available. More... | |
Public Member Functions | |
| MultiDocumentPanel () | |
| Creates an empty panel. | |
| ~MultiDocumentPanel () | |
| Destructor. | |
| bool | closeAllDocuments (bool checkItsOkToCloseFirst) |
| Tries to close all the documents. | |
| bool | addDocument (Component *component, const Colour &backgroundColour, bool deleteWhenRemoved) |
| Adds a document component to the panel. | |
| bool | closeDocument (Component *component, bool checkItsOkToCloseFirst) |
| Closes one of the documents. | |
| int | getNumDocuments () const noexcept |
| Returns the number of open document windows. | |
| Component * | getDocument (int index) const noexcept |
| Returns one of the open documents. | |
| Component * | getActiveDocument () const noexcept |
| Returns the document component that is currently focused or on top. | |
| void | setActiveDocument (Component *component) |
| Makes one of the components active and brings it to the top. | |
| virtual void | activeDocumentChanged () |
| Callback which gets invoked when the currently-active document changes. | |
| void | setMaximumNumDocuments (int maximumNumDocuments) |
| Sets a limit on how many windows can be open at once. | |
| void | useFullscreenWhenOneDocument (bool shouldUseTabs) |
| Sets an option to make the document fullscreen if there's only one document open. | |
| bool | isFullscreenWhenOneDocument () const noexcept |
| Returns the result of the last time useFullscreenWhenOneDocument() was called. | |
| void | setLayoutMode (LayoutMode newLayoutMode) |
| Changes the panel's mode. | |
| LayoutMode | getLayoutMode () const noexcept |
| Returns the current layout mode. | |
| void | setBackgroundColour (const Colour &newBackgroundColour) |
| Sets the background colour for the whole panel. | |
| const Colour & | getBackgroundColour () const noexcept |
| Returns the current background colour. | |
| virtual bool | tryToCloseDocument (Component *component)=0 |
| A subclass must override this to say whether its currently ok for a document to be closed. | |
| virtual MultiDocumentPanelWindow * | createNewDocumentWindow () |
| Creates a new window to be used for a document. | |
| void | paint (Graphics &g) |
| Components can override this method to draw their content. | |
| void | resized () |
| Called when this component's size has been changed. | |
| void | componentNameChanged (Component &) |
| Called when the component's name is changed. | |
A component that contains a set of other components either in floating windows or tabs.
This acts as a panel that can be used to hold a set of open document windows, with different layout modes.
Use addDocument() and closeDocument() to add or remove components from the panel - never use any of the Component methods to access the panel's child components directly, as these are managed internally.
The different layout modes available.
| FloatingWindows |
In this mode, there are overlapping DocumentWindow components for each document. |
| MaximisedWindowsWithTabs |
In this mode, a TabbedComponent is used to show one document at a time. |
| MultiDocumentPanel::MultiDocumentPanel | ( | ) |
Creates an empty panel.
Use addDocument() and closeDocument() to add or remove components from the panel - never use any of the Component methods to access the panel's child components directly, as these are managed internally.
| MultiDocumentPanel::~MultiDocumentPanel | ( | ) |
Destructor.
When deleted, this will call closeAllDocuments (false) to make sure all its components are deleted. If you need to make sure all documents are saved before closing, then you should call closeAllDocuments (true) and check that it returns true before deleting the panel.
| bool MultiDocumentPanel::closeAllDocuments | ( | bool | checkItsOkToCloseFirst ) |
Tries to close all the documents.
If checkItsOkToCloseFirst is true, then the tryToCloseDocument() method will be called for each open document, and any of these calls fails, this method will stop and return false, leaving some documents still open.
If checkItsOkToCloseFirst is false, then all documents will be closed unconditionally.
| bool MultiDocumentPanel::addDocument | ( | Component * | component, |
| const Colour & | backgroundColour, | ||
| bool | deleteWhenRemoved | ||
| ) |
Adds a document component to the panel.
If the number of documents would exceed the limit set by setMaximumNumDocuments() then this will fail and return false. (If it does fail, the component passed-in will not be deleted, even if deleteWhenRemoved was set to true).
The MultiDocumentPanel will deal with creating a window border to go around your component, so just pass in the bare content component here, no need to give it a ResizableWindow or DocumentWindow.
| component | the component to add |
| backgroundColour | the background colour to use to fill the component's window or tab |
| deleteWhenRemoved | if true, then when the component is removed by closeDocument() or closeAllDocuments(), then it will be deleted. If false, then the caller must handle the component's deletion |
| bool MultiDocumentPanel::closeDocument | ( | Component * | component, |
| bool | checkItsOkToCloseFirst | ||
| ) |
Closes one of the documents.
If checkItsOkToCloseFirst is true, then the tryToCloseDocument() method will be called, and if it fails, this method will return false without closing the document.
If checkItsOkToCloseFirst is false, then the documents will be closed unconditionally.
The component will be deleted if the deleteWhenRemoved parameter was set to true when it was added with addDocument.
| int MultiDocumentPanel::getNumDocuments | ( | ) | const |
Returns the number of open document windows.
| Component* MultiDocumentPanel::getDocument | ( | int | index ) | const |
Returns one of the open documents.
The order of the documents in this array may change when they are added, removed or moved around.
| Component* MultiDocumentPanel::getActiveDocument | ( | ) | const |
Returns the document component that is currently focused or on top.
If currently using floating windows, then this will be the component in the currently active window, or the top component if none are active.
If it's currently in tabbed mode, then it'll return the component in the active tab.
| void MultiDocumentPanel::setActiveDocument | ( | Component * | component ) |
Makes one of the components active and brings it to the top.
| virtual void MultiDocumentPanel::activeDocumentChanged | ( | ) | [virtual] |
Callback which gets invoked when the currently-active document changes.
| void MultiDocumentPanel::setMaximumNumDocuments | ( | int | maximumNumDocuments ) |
Sets a limit on how many windows can be open at once.
If this is zero or less there's no limit (the default). addDocument() will fail if this number is exceeded.
| void MultiDocumentPanel::useFullscreenWhenOneDocument | ( | bool | shouldUseTabs ) |
Sets an option to make the document fullscreen if there's only one document open.
If set to true, then if there's only one document, it'll fill the whole of this component without tabs or a window border. If false, then tabs or a window will always be shown, even if there's only one document. If there's more than one document open, then this option makes no difference.
| bool MultiDocumentPanel::isFullscreenWhenOneDocument | ( | ) | const |
Returns the result of the last time useFullscreenWhenOneDocument() was called.
| void MultiDocumentPanel::setLayoutMode | ( | LayoutMode | newLayoutMode ) |
Changes the panel's mode.
| LayoutMode MultiDocumentPanel::getLayoutMode | ( | ) | const |
Returns the current layout mode.
| void MultiDocumentPanel::setBackgroundColour | ( | const Colour & | newBackgroundColour ) |
Sets the background colour for the whole panel.
Each document has its own background colour, but this is the one used to fill the areas behind them.
| const Colour& MultiDocumentPanel::getBackgroundColour | ( | ) | const |
Returns the current background colour.
| virtual bool MultiDocumentPanel::tryToCloseDocument | ( | Component * | component ) | [pure virtual] |
A subclass must override this to say whether its currently ok for a document to be closed.
This method is called by closeDocument() and closeAllDocuments() to indicate that a document should be saved if possible, ready for it to be closed.
If this method returns true, then it means the document is ok and can be closed.
If it returns false, then it means that the closeDocument() method should stop and not close.
Normally, you'd use this method to ask the user if they want to save any changes, then return true if the save operation went ok. If the user cancelled the save operation you could return false here to abort the close operation.
If your component is based on the FileBasedDocument class, then you'd probably want to call FileBasedDocument::saveIfNeededAndUserAgrees() and return true if this returned FileBasedDocument::savedOk
| virtual MultiDocumentPanelWindow* MultiDocumentPanel::createNewDocumentWindow | ( | ) | [virtual] |
Creates a new window to be used for a document.
The default implementation of this just returns a basic MultiDocumentPanelWindow object, but you might want to override it to return a custom component.
| void MultiDocumentPanel::paint | ( | Graphics & | g ) | [virtual] |
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In Juce (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
| g | the graphics context that must be used to do the drawing operations. |
Reimplemented from Component.
| void MultiDocumentPanel::resized | ( | ) | [virtual] |
Called when this component's size has been changed.
A component can implement this method to do things such as laying out its child components when its width or height changes.
The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).
If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.
Reimplemented from Component.
| void MultiDocumentPanel::componentNameChanged | ( | Component & | component ) | [virtual] |
Called when the component's name is changed.
Reimplemented from ComponentListener.
