#include <juce_ResizableWindow.h>
Classes | |
| struct | LookAndFeelMethods |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1005700 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Protected Attributes | |
| std::unique_ptr< ResizableCornerComponent > | resizableCorner |
| std::unique_ptr< ResizableBorderComponent > | resizableBorder |
Private Member Functions | |
| void | initialise (bool addToDesktop) |
| void | updateLastPosIfNotFullScreen () |
| void | updateLastPosIfShowing () |
| void | setContent (Component *, bool takeOwnership, bool resizeToFit) |
| void | updatePeerConstrainer () |
Private Attributes | |
| Component::SafePointer< Component > | contentComponent |
| bool | ownsContentComponent = false |
| bool | resizeToFitContent = false |
| bool | fullscreen = false |
| bool | canDrag = true |
| bool | dragStarted = false |
| ComponentDragger | dragger |
| Rectangle< int > | lastNonFullScreenPos |
| ComponentBoundsConstrainer | defaultConstrainer |
| ComponentBoundsConstrainer * | constrainer = nullptr |
Detailed Description
A base class for top-level windows that can be dragged around and resized.
To add content to the window, use its setContentOwned() or setContentNonOwned() methods to give it a component that will remain positioned inside it (leaving a gap around the edges for a border).
It's not advisable to add child components directly to a ResizableWindow: 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).
By default resizing isn't enabled - use the setResizable() method to enable it and to choose the style of resizing to use.
- See also
- TopLevelWindow
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::ResizableWindow::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 | |
|---|---|
| backgroundColourId | A colour to use to fill the window's background. |
Constructor & Destructor Documentation
◆ ResizableWindow() [1/2]
Creates a ResizableWindow.
This constructor doesn't specify a background colour, so the LookAndFeel's default background colour will be used.
- Parameters
-
name the name to give the component addToDesktop if true, the window will be automatically added to the desktop; if false, you can use it as a child component
◆ ResizableWindow() [2/2]
| juce::ResizableWindow::ResizableWindow | ( | const String & | name, |
| Colour | backgroundColour, | ||
| bool | addToDesktop ) |
Creates a ResizableWindow.
- Parameters
-
name the name to give the component backgroundColour the colour to use for filling the window's background. addToDesktop if true, the window will be automatically added to the desktop; if false, you can use it as a child component
◆ ~ResizableWindow()
|
override |
Destructor. If a content component has been set with setContentOwned(), it will be deleted.
Member Function Documentation
◆ activeWindowStatusChanged()
|
overrideprotectedvirtual |
This callback happens when this window becomes active or inactive.
- See also
- isActiveWindow
Reimplemented from juce::TopLevelWindow.
◆ addToDesktop() [1/2]
| void juce::TopLevelWindow::addToDesktop | ( | ) |
Adds the window to the desktop using the default flags.
◆ addToDesktop() [2/2]
|
overridevirtual |
Makes this component appear as a window on the desktop.
Note that before calling this, you should make sure that the component's opacity is set correctly using setOpaque(). If the component is non-opaque, the windowing system will try to create a special transparent window for it, which will generally take a lot more CPU to operate (and might not even be possible on some platforms).
If the component is inside a parent component at the time this method is called, it will first be removed from that parent. Likewise if a component is on the desktop and is subsequently added to another component, it'll be removed from the desktop.
- Parameters
-
windowStyleFlags a combination of the flags specified in the ComponentPeer::StyleFlags enum, which define the window's characteristics. nativeWindowToAttachTo this allows an OS object to be passed-in as the window in which the juce component should place itself. On Windows, this would be a HWND, a HIViewRef on the Mac. Not necessarily supported on all platforms, and best left as 0 unless you know what you're doing.
- See also
- removeFromDesktop, isOnDesktop, userTriedToCloseWindow, getPeer, ComponentPeer::setMinimised, ComponentPeer::StyleFlags, ComponentPeer::getStyleFlags, ComponentPeer::setFullScreen
Reimplemented from juce::Component.
◆ childBoundsChanged()
Called when one of this component's children is moved or resized.
If the parent wants to know about changes to its immediate children (not to children of its children), this is the method to override.
- See also
- moved, resized, parentSizeChanged
Reimplemented from juce::Component.
◆ clearContentComponent()
| void juce::ResizableWindow::clearContentComponent | ( | ) |
Removes the current content component. If the previous content component was added with setContentOwned(), it will also be deleted. If it was added with setContentNonOwned(), it will simply be removed from this component.
◆ getBackgroundColour()
|
noexcept |
Returns the colour currently being used for the window's background.
As a convenience the window will fill itself with this colour, but you can override the paint() method if you need more customised behaviour.
This method is the same as retrieving the colour for ResizableWindow::backgroundColourId.
- See also
- setBackgroundColour
◆ getBorderThickness() [1/2]
|
virtual |
Returns the width of the frame to use around the window.
- See also
- getContentComponentBorder
Reimplemented in juce::DocumentWindow.
◆ getBorderThickness() [2/2]
|
protected |
◆ getConstrainer()
|
inlinenoexcept |
Returns the bounds constrainer object that this window is using. You can access this to change its properties.
◆ getContentComponent()
|
inlinenoexcept |
Returns the current content component.
This will be the component set by setContentOwned() or setContentNonOwned, or nullptr if none has yet been specified.
- See also
- setContentOwned, setContentNonOwned
◆ getContentComponentBorder() [1/2]
|
virtual |
Returns the insets to use when positioning the content component.
- See also
- getBorderThickness
Reimplemented in juce::DocumentWindow.
◆ getContentComponentBorder() [2/2]
|
protected |
◆ getDesktopWindowStyleFlags()
|
overrideprotectedvirtual |
Reimplemented from juce::TopLevelWindow.
◆ getWindowStateAsString()
| String juce::ResizableWindow::getWindowStateAsString | ( | ) |
Returns a string which encodes the window's current size and position.
This string will encapsulate the window's size, position, and whether it's in full-screen mode. It's intended for letting your application save and restore a window's position.
Use the restoreWindowStateFromString() to restore from a saved state.
- See also
- restoreWindowStateFromString
◆ initialise()
|
private |
◆ isDraggable()
|
inlinenoexcept |
Returns true if the window can be dragged around by the user.
◆ isFullScreen()
| bool juce::ResizableWindow::isFullScreen | ( | ) | const |
Returns true if the window is currently in full-screen mode.
- See also
- setFullScreen
◆ isKioskMode()
| bool juce::ResizableWindow::isKioskMode | ( | ) | const |
Returns true if the window has been placed in kiosk-mode.
- See also
- Desktop::setKioskComponent
◆ isMinimised()
| bool juce::ResizableWindow::isMinimised | ( | ) | const |
Returns true if the window is currently minimised.
- See also
- setMinimised
◆ isResizable()
|
noexcept |
Returns true if resizing is enabled.
- See also
- setResizable
◆ lookAndFeelChanged()
|
overrideprotectedvirtual |
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.
◆ mouseDown()
|
overrideprotectedvirtual |
Called when a mouse button is pressed.
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.
Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseUp, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ mouseDrag()
|
overrideprotectedvirtual |
Called when the mouse is moved while a button is held down.
When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval
Reimplemented from juce::Component.
◆ mouseUp()
|
overrideprotectedvirtual |
Called when a mouse button is released.
A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.
The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ moved()
|
overrideprotectedvirtual |
(if overriding this, make sure you call ResizableWindow::moved() in your subclass)
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.
◆ parentSizeChanged()
|
overrideprotectedvirtual |
Called when this component's immediate parent has been resized.
If the component is a top-level window, this indicates that the screen size has changed.
- See also
- childBoundsChanged, moved, resized
Reimplemented from juce::Component.
◆ resized()
|
overrideprotectedvirtual |
(if overriding this, make sure you call ResizableWindow::resized() in your subclass)
Reimplemented from juce::Component.
◆ restoreWindowStateFromString()
Restores the window to a previously-saved size and position.
This restores the window's size, position and full-screen status from an string that was previously created with the getWindowStateAsString() method.
- Returns
- false if the string wasn't a valid window state
- See also
- getWindowStateAsString
◆ setBackgroundColour()
Changes the colour currently being used for the window's background.
As a convenience the window will fill itself with this colour, but you can override the paint() method if you need more customised behaviour.
Note that the opaque state of this window is altered by this call to reflect the opacity of the colour passed-in. On window systems which can't support semi-transparent windows this might cause problems, (though it's unlikely you'll be using this class as a base for a semi-transparent component anyway).
You can also use the ResizableWindow::backgroundColourId colour id to set this colour.
- See also
- getBackgroundColour
◆ setBoundsConstrained()
Calls the window's setBounds method, after first checking these bounds with the current constrainer.
- See also
- setConstrainer
◆ setConstrainer()
| void juce::ResizableWindow::setConstrainer | ( | ComponentBoundsConstrainer * | newConstrainer | ) |
Sets the bounds-constrainer object to use for resizing and dragging this window.
A pointer to the object you pass in will be kept, but it won't be deleted by this object, so it's the caller's responsibility to manage it.
If you pass a nullptr, then no constraints will be placed on the positioning of the window.
◆ setContent()
|
private |
◆ setContentComponent()
| void juce::ResizableWindow::setContentComponent | ( | Component * | newContentComponent, |
| bool | deleteOldOne = true, | ||
| bool | resizeToFit = false ) |
◆ setContentComponentSize()
Changes the window so that the content component ends up with the specified size.
This is basically a setSize call on the window, but which adds on the borders, so you can specify the content component's target size.
◆ setContentNonOwned()
| void juce::ResizableWindow::setContentNonOwned | ( | Component * | newContentComponent, |
| bool | resizeToFitWhenContentChangesSize ) |
Changes the current content component.
This sets a component that will be placed in the centre of the ResizableWindow, (leaving a space around the edge for the border).
You should never add components directly to a ResizableWindow (or any of its subclasses) with addChildComponent(). Instead, add them to the content component.
- Parameters
-
newContentComponent the new component to use - this component will NOT be deleted by this component, so it's the caller's responsibility to manage its lifetime (it's ok to delete it while this window is still using it). To set a content component that the window will delete, call setContentOwned() instead. resizeToFitWhenContentChangesSize if true, then the ResizableWindow will maintain its size such that it always fits around the size of the content component. If false, the new content will be resized to fit the current space available.
◆ setContentOwned()
| void juce::ResizableWindow::setContentOwned | ( | Component * | newContentComponent, |
| bool | resizeToFitWhenContentChangesSize ) |
Changes the current content component.
This sets a component that will be placed in the centre of the ResizableWindow, (leaving a space around the edge for the border).
You should never add components directly to a ResizableWindow (or any of its subclasses) with addChildComponent(). Instead, add them to the content component.
- Parameters
-
newContentComponent the new component to use - this component will be deleted when it's no longer needed (i.e. when the window is deleted or a new content component is set for it). To set a component that this window will not delete, call setContentNonOwned() instead. resizeToFitWhenContentChangesSize if true, then the ResizableWindow will maintain its size such that it always fits around the size of the content component. If false, the new content will be resized to fit the current space available.
◆ setDraggable()
|
noexcept |
Can be used to enable or disable user-dragging of the window.
◆ setFullScreen()
| void juce::ResizableWindow::setFullScreen | ( | bool | shouldBeFullScreen | ) |
Puts the window into full-screen mode, or restores it to its normal size.
If true, the window will become full-screen; if false, it will return to the last size it was before being made full-screen.
- See also
- isFullScreen
◆ setMinimised()
| void juce::ResizableWindow::setMinimised | ( | bool | shouldMinimise | ) |
Minimises the window, or restores it to its previous position and size.
When being un-minimised, it'll return to the last position and size it was in before being minimised.
- See also
- isMinimised
◆ setResizable()
| void juce::ResizableWindow::setResizable | ( | bool | shouldBeResizable, |
| bool | useBottomRightCornerResizer ) |
Make the window resizable or fixed.
- Parameters
-
shouldBeResizable whether it's resizable at all useBottomRightCornerResizer if true, it'll add a ResizableCornerComponent at the bottom-right; if false, it'll use a ResizableBorderComponent around the edge
- See also
- setResizeLimits, isResizable
◆ setResizeLimits()
|
noexcept |
This sets the maximum and minimum sizes for the window.
If the window's current size is outside these limits, it will be resized to make sure it's within them.
A direct call to setBounds() will bypass any constraint checks, but when the window is dragged by the user or resized by other indirect means, the constrainer will limit the numbers involved.
- See also
- setResizable, setFixedAspectRatio
◆ updateLastPosIfNotFullScreen()
|
private |
◆ updateLastPosIfShowing()
|
private |
◆ updatePeerConstrainer()
|
private |
◆ visibilityChanged()
|
overrideprotectedvirtual |
Called when this component's visibility changes.
- See also
- setVisible, isVisible
Reimplemented from juce::Component.
Member Data Documentation
◆ canDrag
|
private |
◆ constrainer
|
private |
◆ contentComponent
|
private |
◆ defaultConstrainer
|
private |
◆ dragger
|
private |
◆ dragStarted
|
private |
◆ fullscreen
|
private |
◆ lastNonFullScreenPos
◆ ownsContentComponent
|
private |
◆ resizableBorder
|
protected |
◆ resizableCorner
|
protected |
◆ resizeToFitContent
|
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_ResizableWindow.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_ResizableWindow.cpp
Generated on for LMMS by
1.16.1