Public Member Functions

MultiDocumentPanelWindow Class Reference

This is a derivative of DocumentWindow that is used inside a MultiDocumentPanel component. More...

Inherits DocumentWindow.

List of all members.

Public Member Functions

 MultiDocumentPanelWindow (const Colour &backgroundColour)
 ~MultiDocumentPanelWindow ()
 Destructor.
void maximiseButtonPressed ()
 Callback that is triggered when the maximise button is pressed, or when the title-bar is double-clicked.
void closeButtonPressed ()
 This method is called when the user tries to close the window.
void activeWindowStatusChanged ()
 This callback happens when this window becomes active or inactive.
void broughtToFront ()
 Called when this component has been moved to the front of its siblings.

Detailed Description

This is a derivative of DocumentWindow that is used inside a MultiDocumentPanel component.

It's like a normal DocumentWindow but has some extra functionality to make sure everything works nicely inside a MultiDocumentPanel.

See also:
MultiDocumentPanel

Constructor & Destructor Documentation

MultiDocumentPanelWindow::MultiDocumentPanelWindow ( const Colour backgroundColour )
MultiDocumentPanelWindow::~MultiDocumentPanelWindow (  )

Destructor.


Member Function Documentation

void MultiDocumentPanelWindow::maximiseButtonPressed (  ) [virtual]

Callback that is triggered when the maximise button is pressed, or when the title-bar is double-clicked.

The default implementation of this calls ResizableWindow::setFullScreen(), but you can override it to do more customised behaviour.

Reimplemented from DocumentWindow.

void MultiDocumentPanelWindow::closeButtonPressed (  ) [virtual]

This method is called when the user tries to close the window.

This is triggered by the user clicking the close button, or using some other OS-specific key shortcut or OS menu for getting rid of a window.

If the window is just a pop-up, you should override this closeButtonPressed() method and make it delete the window in whatever way is appropriate for your app. E.g. you might just want to call "delete this".

If your app is centred around this window such that the whole app should quit when the window is closed, then you will probably want to use this method as an opportunity to call JUCEApplication::quit(), and leave the window to be deleted later by your JUCEApplication::shutdown() method. (Doing it this way means that your window will still get cleaned-up if the app is quit by some other means (e.g. a cmd-Q on the mac or closing it via the taskbar icon on Windows).

(Note that the DocumentWindow class overrides Component::userTriedToCloseWindow() and redirects it to call this method, so any methods of closing the window that are caught by userTriedToCloseWindow() will also end up here).

Reimplemented from DocumentWindow.

void MultiDocumentPanelWindow::activeWindowStatusChanged (  ) [virtual]

This callback happens when this window becomes active or inactive.

See also:
isActiveWindow

Reimplemented from ResizableWindow.

void MultiDocumentPanelWindow::broughtToFront (  ) [virtual]

Called when this component has been moved to the front of its siblings.

The component may have been brought to the front by the toFront() method, or by the operating system if it's a top-level window.

See also:
toFront

Reimplemented from Component.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines