A base class for top-level windows that can be dragged around and resized. More...

Inherited by DocumentWindow, and FileChooserDialogBox.

Public Types
enum	ColourIds { backgroundColourId = 0x1005700 }
	A set of colour IDs to use to change the colour of various aspects of the window. More...
Public Member Functions
	ResizableWindow (const String &name, bool addToDesktop)
	Creates a ResizableWindow.
	ResizableWindow (const String &name, const Colour &backgroundColour, bool addToDesktop)
	Creates a ResizableWindow.
	~ResizableWindow ()
	Destructor.
const Colour	getBackgroundColour () const noexcept
	Returns the colour currently being used for the window's background.
void	setBackgroundColour (const Colour &newColour)
	Changes the colour currently being used for the window's background.
void	setResizable (bool shouldBeResizable, bool useBottomRightCornerResizer)
	Make the window resizable or fixed.
bool	isResizable () const noexcept
	True if resizing is enabled.
void	setResizeLimits (int newMinimumWidth, int newMinimumHeight, int newMaximumWidth, int newMaximumHeight) noexcept
	This sets the maximum and minimum sizes for the window.
ComponentBoundsConstrainer *	getConstrainer () noexcept
	Returns the bounds constrainer object that this window is using.
void	setConstrainer (ComponentBoundsConstrainer *newConstrainer)
	Sets the bounds-constrainer object to use for resizing and dragging this window.
void	setBoundsConstrained (const Rectangle< int > &bounds)
	Calls the window's setBounds method, after first checking these bounds with the current constrainer.
bool	isFullScreen () const
	Returns true if the window is currently in full-screen mode.
void	setFullScreen (bool shouldBeFullScreen)
	Puts the window into full-screen mode, or restores it to its normal size.
bool	isMinimised () const
	Returns true if the window is currently minimised.
void	setMinimised (bool shouldMinimise)
	Minimises the window, or restores it to its previous position and size.
void	addToDesktop ()
	Adds the window to the desktop using the default flags.
String	getWindowStateAsString ()
	Returns a string which encodes the window's current size and position.
bool	restoreWindowStateFromString (const String &previousState)
	Restores the window to a previously-saved size and position.
Component *	getContentComponent () const noexcept
	Returns the current content component.
void	setContentOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
	Changes the current content component.
void	setContentNonOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
	Changes the current content component.
void	clearContentComponent ()
	Removes the current content component.
void	setContentComponentSize (int width, int height)
	Changes the window so that the content component ends up with the specified size.
virtual const BorderSize< int >	getBorderThickness ()
	Returns the width of the frame to use around the window.
virtual const BorderSize< int >	getContentComponentBorder ()
	Returns the insets to use when positioning the content component.
	JUCE_DEPRECATED (void setContentComponent(Component *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false))
Protected Member Functions
void	paint (Graphics &g)
	Components can override this method to draw their content.
void	moved ()
	(if overriding this, make sure you call ResizableWindow::resized() in your subclass)
void	resized ()
	(if overriding this, make sure you call ResizableWindow::resized() in your subclass)
void	mouseDown (const MouseEvent &e)
	Called when a mouse button is pressed while it's over this component.
void	mouseDrag (const MouseEvent &e)
	Called when the mouse is moved while a button is held down.
void	lookAndFeelChanged ()
	Called to let the component react to a change in the look-and-feel setting.
void	childBoundsChanged (Component *child)
	Called when one of this component's children is moved or resized.
void	parentSizeChanged ()
	Called when this component's immediate parent has been resized.
void	visibilityChanged ()
	Called when this component's visiblility changes.
void	activeWindowStatusChanged ()
	This callback happens when this window becomes active or inactive.
int	getDesktopWindowStyleFlags () const
Protected Attributes
ScopedPointer < ResizableCornerComponent >	resizableCorner
ScopedPointer < ResizableBorderComponent >	resizableBorder

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

Member Enumeration Documentation

enum 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.

Reimplemented in FileChooserDialogBox, and DocumentWindow.

Constructor & Destructor Documentation

ResizableWindow::ResizableWindow	(	const String &	name,
		bool	addToDesktop
	)

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::ResizableWindow	(	const String &	name,
		const 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::~ResizableWindow ( )

Destructor.

If a content component has been set with setContentOwned(), it will be deleted.

Member Function Documentation

const Colour ResizableWindow::getBackgroundColour ( ) const

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

void ResizableWindow::setBackgroundColour ( const Colour & newColour )

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

void 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

bool ResizableWindow::isResizable ( ) const

True if resizing is enabled.

See also:: setResizable

void ResizableWindow::setResizeLimits	(	int	newMinimumWidth,
		int	newMinimumHeight,
		int	newMaximumWidth,
		int	newMaximumHeight
	)

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.

Calling setBounds() on the component will bypass any size checking - it's only when the window is being resized by the user that these values are enforced.

See also:: setResizable, setFixedAspectRatio

ComponentBoundsConstrainer* ResizableWindow::getConstrainer ( )

Returns the bounds constrainer object that this window is using.

You can access this to change its properties.

void 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 responsiblity to manage it.

If you pass 0, then no contraints will be placed on the positioning of the window.

void ResizableWindow::setBoundsConstrained ( const Rectangle< int > & bounds )

Calls the window's setBounds method, after first checking these bounds with the current constrainer.

See also:: setConstrainer

bool ResizableWindow::isFullScreen ( ) const

Returns true if the window is currently in full-screen mode.

See also:: setFullScreen

void 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

bool ResizableWindow::isMinimised ( ) const

Returns true if the window is currently minimised.

See also:: setMinimised

void 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

void ResizableWindow::addToDesktop ( )

Adds the window to the desktop using the default flags.

String 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

bool ResizableWindow::restoreWindowStateFromString ( const String & previousState )

Restores the window to a previously-saved size and position.

This restores the window's size, positon 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

Component* ResizableWindow::getContentComponent ( ) const

Returns the current content component.

This will be the component set by setContentOwned() or setContentNonOwned, or 0 if none has yet been specified.

See also:: setContentOwned, setContentNonOwned

void 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.

void 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.

void 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.

void ResizableWindow::setContentComponentSize	(	int	width,
		int	height
	)

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.

virtual const BorderSize<int> ResizableWindow::getBorderThickness ( ) [virtual]

Returns the width of the frame to use around the window.

See also:: getContentComponentBorder

virtual const BorderSize<int> ResizableWindow::getContentComponentBorder ( ) [virtual]

Returns the insets to use when positioning the content component.

See also:: getBorderThickness

ResizableWindow::JUCE_DEPRECATED ( void setContentComponentComponent *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false )

Deprecated:

use setContentOwned() and setContentNonOwned() instead.

void ResizableWindow::paint ( Graphics & g ) [protected, 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().

Parameters:

g	the graphics context that must be used to do the drawing operations.

See also:: repaint, paintOverChildren, Graphics

Reimplemented from Component.

void ResizableWindow::moved ( ) [protected, virtual]

(if overriding this, make sure you call ResizableWindow::resized() in your subclass)

Reimplemented from Component.

void ResizableWindow::resized ( ) [protected, virtual]

(if overriding this, make sure you call ResizableWindow::resized() in your subclass)

Reimplemented from Component.

Reimplemented in StandaloneFilterWindow, and DialogWindow.

void ResizableWindow::mouseDown ( const MouseEvent & e ) [protected, virtual]

Called when a mouse button is pressed while it's over this 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.

Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.

Parameters:

e	details about the position and status of the mouse event

See also:: mouseUp, mouseDrag, mouseDoubleClick, contains

Reimplemented from Component.

void ResizableWindow::mouseDrag ( const MouseEvent & e ) [protected, virtual]

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.

If you want to be able to drag things off the edge of a component and have the component scroll when you get to the edges, the beginDragAutoRepeat() method might be useful.

Parameters:

e	details about the position and status of the mouse event

See also:: mouseDown, mouseUp, mouseMove, contains, beginDragAutoRepeat

Reimplemented from Component.

void ResizableWindow::lookAndFeelChanged ( ) [protected, virtual]

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.