#include <juce_DocumentWindow.h>
Classes | |
| struct | LookAndFeelMethods |
| class | ButtonListenerProxy |
Public Types | |
| enum | TitleBarButtons { minimiseButton = 1 , maximiseButton = 2 , closeButton = 4 , allButtons = 7 } |
| enum | ColourIds { textColourId = 0x1005701 } |
| Public Types inherited from juce::ResizableWindow | |
| enum | ColourIds { backgroundColourId = 0x1005700 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Private Member Functions | |
| void | repaintTitleBar () |
Private Attributes | |
| int | titleBarHeight = 26 |
| int | menuBarHeight = 24 |
| int | requiredButtons |
| bool | positionTitleBarButtonsOnLeft |
| bool | drawTitleTextCentred = true |
| std::unique_ptr< Button > | titleBarButtons [3] |
| Image | titleBarIcon |
| std::unique_ptr< Component > | menuBar |
| MenuBarModel * | menuBarModel = nullptr |
| std::unique_ptr< ButtonListenerProxy > | buttonListener |
Detailed Description
A resizable window with a title bar and maximise, minimise and close buttons.
This subclass of ResizableWindow creates a fairly standard type of window with a title bar and various buttons. The name of the component is shown in the title bar, and an icon can optionally be specified with setIcon().
All the methods available to a ResizableWindow are also available to this, so it can easily be made resizable, minimised, maximised, etc.
It's not advisable to add child components directly to a DocumentWindow: put them inside your content component instead. And overriding methods like resized(), moved(), etc is also not recommended - instead override these methods for your content component. (If for some obscure reason you do need to override these methods, always remember to call the super-class's resized() method too, otherwise it'll fail to lay out the window decorations correctly).
You can also automatically add a menu bar to the window, using the setMenuBar() method.
- See also
- ResizableWindow, DialogWindow
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::DocumentWindow::ColourIds |
A set of colour IDs to use to change the colour of various aspects of the window.
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.
- See also
- Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
| Enumerator | |
|---|---|
| textColourId | The colour to draw any text with. It's up to the look and feel class how this is used. |
◆ TitleBarButtons
| enum juce::DocumentWindow::TitleBarButtons |
Constructor & Destructor Documentation
◆ DocumentWindow()
| juce::DocumentWindow::DocumentWindow | ( | const String & | name, |
| Colour | backgroundColour, | ||
| int | requiredButtons, | ||
| bool | addToDesktop = true ) |
Creates a DocumentWindow.
- Parameters
-
name the name to give the component - this is also the title shown at the top of the window. To change this later, use setName() backgroundColour the colour to use for filling the window's background. requiredButtons specifies which of the buttons (close, minimise, maximise) should be shown on the title bar. This value is a bitwise combination of values from the TitleBarButtons enum. Note that it can be "allButtons" to get them all. You can change this later with the setTitleBarButtonsRequired() method, which can also specify where they are positioned. The behaviour of native titlebars on macOS is slightly different: the maximiseButton flag controls whether or not the window can enter native fullscreen mode, and the zoom button can be disabled by making the window non-resizable. addToDesktop if true, the window will be automatically added to the desktop; if false, you can use it as a child component
- See also
- TitleBarButtons
◆ ~DocumentWindow()
|
override |
Destructor. If a content component has been set with setContentOwned(), it will be deleted.
Member Function Documentation
◆ activeWindowStatusChanged()
|
overridevirtual |
This callback happens when this window becomes active or inactive.
- See also
- isActiveWindow
Reimplemented from juce::TopLevelWindow.
Reimplemented in juce::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 JUCEApplicationBase::quit(), and leave the window to be deleted later by your JUCEApplicationBase::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 in juce::DefaultDialogWindow, juce::MultiDocumentPanelWindow, and juce::Toolbar::CustomisationDialog.
◆ getBorderThickness()
|
overridevirtual |
Returns the width of the frame to use around the window.
- See also
- getContentComponentBorder
Reimplemented from juce::ResizableWindow.
◆ getCloseButton()
|
noexcept |
Returns the close button, (or nullptr if there isn't one).
◆ getContentComponentBorder()
|
overridevirtual |
Returns the insets to use when positioning the content component.
- See also
- getBorderThickness
Reimplemented from juce::ResizableWindow.
◆ getDesktopWindowStyleFlags()
|
overridevirtual |
Reimplemented from juce::TopLevelWindow.
◆ getMaximiseButton()
|
noexcept |
Returns the maximise button, (or nullptr if there isn't one).
◆ getMenuBarComponent()
|
noexcept |
Returns the current menu bar component, or null if there isn't one. This is probably a MenuBarComponent, unless a custom one has been set using setMenuBarComponent().
◆ getMinimiseButton()
|
noexcept |
Returns the minimise button, (or nullptr if there isn't one).
◆ getTitleBarArea()
◆ getTitleBarHeight()
| int juce::DocumentWindow::getTitleBarHeight | ( | ) | const |
Returns the current title bar height.
◆ lookAndFeelChanged()
|
overridevirtual |
Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.
- See also
- sendLookAndFeelChange, getLookAndFeel
Reimplemented from juce::Component.
◆ maximiseButtonPressed()
|
virtual |
Callback that is triggered when the maximise button is pressed, or when the title-bar is double-clicked.
This function is only called when using a non-native titlebar.
The default implementation of this calls ResizableWindow::setFullScreen(), but you can override it to do more customised behaviour.
Reimplemented in juce::MultiDocumentPanelWindow.
◆ minimiseButtonPressed()
|
virtual |
Callback that is triggered when the minimise button is pressed.
This function is only called when using a non-native titlebar.
The default implementation of this calls ResizableWindow::setMinimised(), but you can override it to do more customised behaviour.
◆ mouseDoubleClick()
|
overridevirtual |
Called when a mouse button has been double-clicked on a component.
The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseUp
Reimplemented from juce::Component.
◆ paint()
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().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ parentHierarchyChanged()
|
overridevirtual |
Called to indicate that the component's parents have changed.
When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).
Subclasses can override this if they need to react to this in some way.
- See also
- getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged
Reimplemented from juce::Component.
◆ repaintTitleBar()
|
private |
◆ resized()
|
overridevirtual |
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.
- See also
- moved, setSize
Reimplemented from juce::Component.
◆ setIcon()
Sets an icon to show in the title bar, next to the title.
A copy is made internally of the image, so the caller can delete the image after calling this. If an empty Image is passed-in, any existing icon will be removed.
◆ setMenuBar()
| void juce::DocumentWindow::setMenuBar | ( | MenuBarModel * | menuBarModel, |
| int | menuBarHeight = 0 ) |
Creates a menu inside this window.
- Parameters
-
menuBarModel this specifies a MenuBarModel that should be used to generate the contents of a menu bar that will be placed just below the title bar, and just above any content component. If this value is a nullptr, any existing menu bar will be removed from the component; if it is not a nullptr, one will be added if it's required. menuBarHeight the height of the menu bar component, if one is needed. Pass a value of zero or less to use the look-and-feel's default size.
◆ setMenuBarComponent()
Replaces the current menu bar with a custom component. The component will be owned and deleted by the document window.
◆ setName()
Changes the component's name.
(This is overridden from Component::setName() to cause a repaint, as the name is what gets drawn across the window's title bar).
Reimplemented from juce::Component.
◆ setTitleBarButtonsRequired()
| void juce::DocumentWindow::setTitleBarButtonsRequired | ( | int | requiredButtons, |
| bool | positionTitleBarButtonsOnLeft ) |
Changes the set of title-bar buttons being shown.
- Parameters
-
requiredButtons specifies which of the buttons (close, minimise, maximise) should be shown on the title bar. This value is a bitwise combination of values from the TitleBarButtons enum. Note that it can be "allButtons" to get them all. The behaviour of native titlebars on macOS is slightly different: the maximiseButton flag controls whether or not the window can enter native fullscreen mode, and the zoom button can be disabled by making the window non-resizable. positionTitleBarButtonsOnLeft if true, the buttons should go at the left side of the bar; if false, they'll be placed at the right
◆ setTitleBarHeight()
◆ setTitleBarTextCentred()
| void juce::DocumentWindow::setTitleBarTextCentred | ( | bool | textShouldBeCentred | ) |
Sets whether the title should be centred within the window.
If true, the title text is shown in the middle of the title-bar; if false, it'll be shown at the left of the bar.
◆ userTriedToCloseWindow()
|
overridevirtual |
For components on the desktop, this is called if the system wants to close the window.
This is a signal that either the user or the system wants the window to close. The default implementation of this method will trigger an assertion to warn you that your component should do something about it, but you can override this to ignore the event if you want.
Reimplemented from juce::Component.
Member Data Documentation
◆ buttonListener
|
private |
◆ drawTitleTextCentred
|
private |
◆ menuBar
|
private |
◆ menuBarHeight
|
private |
◆ menuBarModel
|
private |
◆ positionTitleBarButtonsOnLeft
|
private |
◆ requiredButtons
|
private |
◆ titleBarButtons
|
private |
◆ titleBarHeight
|
private |
◆ titleBarIcon
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_DocumentWindow.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_DocumentWindow.cpp
Generated on for LMMS by
1.16.1