juce::FileChooserDialogBox Class Reference

#include <juce_FileChooserDialogBox.h>

Inheritance diagram for juce::FileChooserDialogBox:

Classes
class	ContentComponent

Public Types
enum	ColourIds { titleTextColourId = 0x1000850 }
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 }

Public Member Functions
	FileChooserDialogBox (const String &title, const String &instructions, FileBrowserComponent &browserComponent, bool warnAboutOverwritingExistingFiles, Colour backgroundColour, Component *parentComponent=nullptr)
	~FileChooserDialogBox () override
void	centreWithDefaultSize (Component *componentToCentreAround=nullptr)
Public Member Functions inherited from juce::ResizableWindow
	ResizableWindow (const String &name, bool addToDesktop)
	ResizableWindow (const String &name, Colour backgroundColour, bool addToDesktop)
	~ResizableWindow () override
Colour	getBackgroundColour () const noexcept
void	setBackgroundColour (Colour newColour)
void	setResizable (bool shouldBeResizable, bool useBottomRightCornerResizer)
bool	isResizable () const noexcept
void	setResizeLimits (int newMinimumWidth, int newMinimumHeight, int newMaximumWidth, int newMaximumHeight) noexcept
void	setDraggable (bool shouldBeDraggable) noexcept
bool	isDraggable () const noexcept
ComponentBoundsConstrainer *	getConstrainer () noexcept
void	setConstrainer (ComponentBoundsConstrainer *newConstrainer)
void	setBoundsConstrained (const Rectangle< int > &newBounds)
bool	isFullScreen () const
void	setFullScreen (bool shouldBeFullScreen)
bool	isMinimised () const
void	setMinimised (bool shouldMinimise)
bool	isKioskMode () const
String	getWindowStateAsString ()
bool	restoreWindowStateFromString (const String &previousState)
Component *	getContentComponent () const noexcept
void	setContentOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
void	setContentNonOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
void	clearContentComponent ()
void	setContentComponentSize (int width, int height)
virtual BorderSize< int >	getBorderThickness ()
virtual BorderSize< int >	getContentComponentBorder ()
void	setContentComponent (Component *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false)
void	addToDesktop ()
void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) override
Public Member Functions inherited from juce::TopLevelWindow
	TopLevelWindow (const String &name, bool addToDesktop)
	~TopLevelWindow () override
bool	isActiveWindow () const noexcept
void	centreAroundComponent (Component *componentToCentreAround, int width, int height)
void	setDropShadowEnabled (bool useShadow)
bool	isDropShadowEnabled () const noexcept
void	setUsingNativeTitleBar (bool useNativeTitleBar)
bool	isUsingNativeTitleBar () const noexcept
void	addToDesktop ()
void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) override
Public Member Functions inherited from juce::Component
	Component () noexcept
	~Component () override
	Component (const String &componentName) noexcept
String	getName () const noexcept
virtual void	setName (const String &newName)
String	getComponentID () const noexcept
void	setComponentID (const String &newID)
virtual void	setVisible (bool shouldBeVisible)
bool	isVisible () const noexcept
bool	isShowing () const
void	removeFromDesktop ()
bool	isOnDesktop () const noexcept
ComponentPeer *	getPeer () const
virtual void	userTriedToCloseWindow ()
virtual void	minimisationStateChanged (bool isNowMinimised)
virtual float	getDesktopScaleFactor () const
void	toFront (bool shouldAlsoGainKeyboardFocus)
void	toBack ()
void	toBehind (Component *other)
void	setAlwaysOnTop (bool shouldStayOnTop)
bool	isAlwaysOnTop () const noexcept
int	getX () const noexcept
int	getY () const noexcept
int	getWidth () const noexcept
int	getHeight () const noexcept
int	getRight () const noexcept
Point< int >	getPosition () const noexcept
int	getBottom () const noexcept
Rectangle< int >	getBounds () const noexcept
Rectangle< int >	getLocalBounds () const noexcept
Rectangle< int >	getBoundsInParent () const noexcept
int	getScreenX () const
int	getScreenY () const
Point< int >	getScreenPosition () const
Rectangle< int >	getScreenBounds () const
Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
Rectangle< int >	getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float >	getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< int >	localPointToGlobal (Point< int > localPoint) const
Point< float >	localPointToGlobal (Point< float > localPoint) const
Rectangle< int >	localAreaToGlobal (Rectangle< int > localArea) const
Rectangle< float >	localAreaToGlobal (Rectangle< float > localArea) const
void	setTopLeftPosition (int x, int y)
void	setTopLeftPosition (Point< int > newTopLeftPosition)
void	setTopRightPosition (int x, int y)
void	setSize (int newWidth, int newHeight)
void	setBounds (int x, int y, int width, int height)
void	setBounds (Rectangle< int > newBounds)
void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
void	setBoundsRelative (Rectangle< float > proportionalArea)
void	setBoundsInset (BorderSize< int > borders)
void	setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
void	setCentrePosition (int x, int y)
void	setCentrePosition (Point< int > newCentrePosition)
void	setCentreRelative (float x, float y)
void	centreWithSize (int width, int height)
void	setTransform (const AffineTransform &transform)
AffineTransform	getTransform () const
bool	isTransformed () const noexcept
int	proportionOfWidth (float proportion) const noexcept
int	proportionOfHeight (float proportion) const noexcept
int	getParentWidth () const noexcept
int	getParentHeight () const noexcept
Rectangle< int >	getParentMonitorArea () const
int	getNumChildComponents () const noexcept
Component *	getChildComponent (int index) const noexcept
int	getIndexOfChildComponent (const Component *child) const noexcept
const Array< Component * > &	getChildren () const noexcept
Component *	findChildWithID (StringRef componentID) const noexcept
void	addChildComponent (Component *child, int zOrder=-1)
void	addChildComponent (Component &child, int zOrder=-1)
void	addAndMakeVisible (Component *child, int zOrder=-1)
void	addAndMakeVisible (Component &child, int zOrder=-1)
void	addChildAndSetID (Component *child, const String &componentID)
void	removeChildComponent (Component *childToRemove)
Component *	removeChildComponent (int childIndexToRemove)
void	removeAllChildren ()
void	deleteAllChildren ()
Component *	getParentComponent () const noexcept
template<class TargetClass>
TargetClass *	findParentComponentOfClass () const
Component *	getTopLevelComponent () const noexcept
bool	isParentOf (const Component *possibleChild) const noexcept
virtual void	childrenChanged ()
virtual bool	hitTest (int x, int y)
void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
bool	contains (Point< int > localPoint)
bool	contains (Point< float > localPoint)
bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
bool	reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
Component *	getComponentAt (int x, int y)
Component *	getComponentAt (Point< int > position)
Component *	getComponentAt (Point< float > position)
void	repaint ()
void	repaint (int x, int y, int width, int height)
void	repaint (Rectangle< int > area)
void	setBufferedToImage (bool shouldBeBuffered)
Image	createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
bool	isPaintingUnclipped () const noexcept
void	setComponentEffect (ImageEffectFilter *newEffect)
ImageEffectFilter *	getComponentEffect () const noexcept
LookAndFeel &	getLookAndFeel () const noexcept
void	setLookAndFeel (LookAndFeel *newLookAndFeel)
void	sendLookAndFeelChange ()
void	setOpaque (bool shouldBeOpaque)
bool	isOpaque () const noexcept
void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
bool	isBroughtToFrontOnMouseClick () const noexcept
void	setExplicitFocusOrder (int newFocusOrderIndex)
int	getExplicitFocusOrder () const
void	setFocusContainerType (FocusContainerType containerType) noexcept
bool	isFocusContainer () const noexcept
bool	isKeyboardFocusContainer () const noexcept
Component *	findFocusContainer () const
Component *	findKeyboardFocusContainer () const
void	setWantsKeyboardFocus (bool wantsFocus) noexcept
bool	getWantsKeyboardFocus () const noexcept
void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
bool	getMouseClickGrabsKeyboardFocus () const noexcept
void	grabKeyboardFocus ()
void	giveAwayKeyboardFocus ()
bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
void	moveKeyboardFocusToSibling (bool moveToNext)
virtual std::unique_ptr< ComponentTraverser >	createFocusTraverser ()
virtual std::unique_ptr< ComponentTraverser >	createKeyboardFocusTraverser ()
void	setHasFocusOutline (bool hasFocusOutline) noexcept
bool	hasFocusOutline () const noexcept
bool	isEnabled () const noexcept
void	setEnabled (bool shouldBeEnabled)
virtual void	enablementChanged ()
float	getAlpha () const noexcept
void	setAlpha (float newAlpha)
virtual void	alphaChanged ()
void	setMouseCursor (const MouseCursor &cursorType)
virtual MouseCursor	getMouseCursor ()
void	updateMouseCursor () const
virtual void	paintOverChildren (Graphics &g)
void	mouseMove (const MouseEvent &event) override
void	mouseEnter (const MouseEvent &event) override
void	mouseExit (const MouseEvent &event) override
void	mouseDoubleClick (const MouseEvent &event) override
void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
void	mouseMagnify (const MouseEvent &event, float scaleFactor) override
void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
void	removeMouseListener (MouseListener *listenerToRemove)
void	addKeyListener (KeyListener *newListener)
void	removeKeyListener (KeyListener *listenerToRemove)
virtual bool	keyPressed (const KeyPress &key)
virtual bool	keyStateChanged (bool isKeyDown)
virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
virtual void	focusGained (FocusChangeType cause)
virtual void	focusLost (FocusChangeType cause)
bool	isMouseOver (bool includeChildren=false) const
bool	isMouseButtonDown (bool includeChildren=false) const
bool	isMouseOverOrDragging (bool includeChildren=false) const
Point< int >	getMouseXYRelative () const
virtual void	broughtToFront ()
void	addComponentListener (ComponentListener *newListener)
void	removeComponentListener (ComponentListener *listenerToRemove)
void	postCommandMessage (int commandId)
virtual void	handleCommandMessage (int commandId)
void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
void	exitModalState (int returnValue)
bool	isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
bool	isCurrentlyBlockedByAnotherModalComponent () const
virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)
virtual void	inputAttemptWhenModal ()
NamedValueSet &	getProperties () noexcept
const NamedValueSet &	getProperties () const noexcept
Colour	findColour (int colourID, bool inheritFromParent=false) const
void	setColour (int colourID, Colour newColour)
void	removeColour (int colourID)
bool	isColourSpecified (int colourID) const
void	copyAllExplicitColoursTo (Component &target) const
virtual void	colourChanged ()
void *	getWindowHandle () const
Positioner *	getPositioner () const noexcept
void	setPositioner (Positioner *newPositioner)
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImage *	getCachedComponentImage () const noexcept
void	setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
bool	getViewportIgnoreDragFlag () const noexcept
String	getTitle () const noexcept
void	setTitle (const String &newTitle)
String	getDescription () const noexcept
void	setDescription (const String &newDescription)
String	getHelpText () const noexcept
void	setHelpText (const String &newHelpText)
void	setAccessible (bool shouldBeAccessible)
bool	isAccessible () const noexcept
AccessibilityHandler *	getAccessibilityHandler ()
void	invalidateAccessibilityHandler ()
void	setFocusContainer (bool shouldBeFocusContainer) noexcept
void	contains (int, int)=delete
Public Member Functions inherited from juce::MouseListener
virtual	~MouseListener ()=default

Private Member Functions
void	closeButtonPressed ()
void	selectionChanged () override
void	fileClicked (const File &, const MouseEvent &) override
void	fileDoubleClicked (const File &) override
void	browserRootChanged (const File &) override
int	getDefaultWidth () const
void	okButtonPressed ()
void	createNewFolder ()
void	createNewFolderConfirmed (const String &name)
Private Member Functions inherited from juce::FileBrowserListener
virtual	~FileBrowserListener ()

Static Private Member Functions
static void	okToOverwriteFileCallback (int result, FileChooserDialogBox *)
static void	createNewFolderCallback (int result, FileChooserDialogBox *, Component::SafePointer< AlertWindow >)

Private Attributes
ContentComponent *	content
const bool	warnAboutOverwritingExistingFiles

Additional Inherited Members
Static Public Member Functions inherited from juce::TopLevelWindow
static int	getNumTopLevelWindows () noexcept
static TopLevelWindow *	getTopLevelWindow (int index) noexcept
static TopLevelWindow *	getActiveTopLevelWindow () noexcept
Static Public Member Functions inherited from juce::Component
static float JUCE_CALLTYPE	getApproximateScaleFactorForComponent (const Component *targetComponent)
static Component *JUCE_CALLTYPE	getCurrentlyFocusedComponent () noexcept
static void JUCE_CALLTYPE	unfocusAllComponents ()
static void JUCE_CALLTYPE	beginDragAutoRepeat (int millisecondsBetweenCallbacks)
static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept
static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept
static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept
Protected Member Functions inherited from juce::ResizableWindow
void	paint (Graphics &) override
void	moved () override
void	resized () override
void	mouseDown (const MouseEvent &) override
void	mouseDrag (const MouseEvent &) override
void	mouseUp (const MouseEvent &) override
void	lookAndFeelChanged () override
void	childBoundsChanged (Component *) override
void	parentSizeChanged () override
void	visibilityChanged () override
void	activeWindowStatusChanged () override
int	getDesktopWindowStyleFlags () const override
void	getBorderThickness (int &left, int &top, int &right, int &bottom)
void	getContentComponentBorder (int &left, int &top, int &right, int &bottom)
Protected Member Functions inherited from juce::TopLevelWindow
void	focusOfChildComponentChanged (FocusChangeType) override
void	parentHierarchyChanged () override
void	recreateDesktopWindow ()
void	visibilityChanged () override
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)
Protected Attributes inherited from juce::ResizableWindow
std::unique_ptr< ResizableCornerComponent >	resizableCorner
std::unique_ptr< ResizableBorderComponent >	resizableBorder

Detailed Description

A file open/save dialog box.

This is a Juce-based file dialog box; to use a native file chooser, see the FileChooser class.

{
    wildcardFilter = std::make_unique<WildcardFileFilter> ("*.foo", String(), "Foo files");
 
    browser = std::make_unique<FileBrowserComponent> (FileBrowserComponent::canSelectFiles,
                                                      File(),
                                                      wildcardFilter.get(),
                                                      nullptr);
 
    dialogBox = std::make_unique<FileChooserDialogBox> ("Open some kind of file",
                                                        "Please choose some kind of file that you want to open...",
                                                        *browser,
                                                        false,
                                                        Colours::lightgrey);
 
    auto onFileSelected = [this] (int r)
    {
        modalStateFinished (r);
 
        auto selectedFile = browser->getSelectedFile (0);
 
        ...etc...
    };
 
    dialogBox->centreWithDefaultSize (nullptr);
    dialogBox->enterModalState (true,
                                ModalCallbackFunction::create (onFileSelected),
                                true);
}

See also

FileChooser

@tags{GUI}

Member Enumeration Documentation

ColourIds

enum juce::FileChooserDialogBox::ColourIds

A set of colour IDs to use to change the colour of various aspects of the box.

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
titleTextColourId	The colour to use to draw the box's title.

Constructor & Destructor Documentation

FileChooserDialogBox()

juce::FileChooserDialogBox::FileChooserDialogBox	(	const String &	title,
		const String &	instructions,
		FileBrowserComponent &	browserComponent,
		bool	warnAboutOverwritingExistingFiles,
		Colour	backgroundColour,
		Component *	parentComponent = nullptr )

Creates a file chooser box.

Parameters

title	the main title to show at the top of the box
instructions	an optional longer piece of text to show below the title in a smaller font, describing in more detail what's required.
browserComponent	a FileBrowserComponent that will be shown inside this dialog box. Make sure you delete this after (but not before!) the dialog box has been deleted.
warnAboutOverwritingExistingFiles	if true, then the user will be asked to confirm if they try to select a file that already exists. (This flag is only used when saving files)
backgroundColour	the background colour for the top level window
parentComponent	an optional component which should be the parent for the file chooser. If this is a nullptr then the dialog box will be a top-level window. AUv3s on iOS must specify this parameter as opening a top-level window in an AUv3 is forbidden due to sandbox restrictions.

See also

FileBrowserComponent, FilePreviewComponent

~FileChooserDialogBox()

juce::FileChooserDialogBox::~FileChooserDialogBox ( )

override

Destructor.

Member Function Documentation

browserRootChanged()

void juce::FileChooserDialogBox::browserRootChanged ( const File & newRoot )

overrideprivatevirtual

Callback when the browser's root folder changes.

Implements juce::FileBrowserListener.

centreWithDefaultSize()

void juce::FileChooserDialogBox::centreWithDefaultSize

(

Component *

componentToCentreAround = nullptr

)

Sets the size of this dialog box to its default and positions it either in the centre of the screen, or centred around a component that is provided.

closeButtonPressed()

void juce::FileChooserDialogBox::closeButtonPressed ( )

private

createNewFolder()

void juce::FileChooserDialogBox::createNewFolder ( )

private

createNewFolderCallback()

void juce::FileChooserDialogBox::createNewFolderCallback ( int result, FileChooserDialogBox * box, Component::SafePointer< AlertWindow > alert )

staticprivate

createNewFolderConfirmed()

void juce::FileChooserDialogBox::createNewFolderConfirmed ( const String & name )

private

fileClicked()

void juce::FileChooserDialogBox::fileClicked ( const File & file, const MouseEvent & e )

overrideprivatevirtual

Callback when the user clicks on a file in the browser.

Implements juce::FileBrowserListener.

fileDoubleClicked()

void juce::FileChooserDialogBox::fileDoubleClicked ( const File & file )

overrideprivatevirtual

Callback when the user double-clicks on a file in the browser.

Implements juce::FileBrowserListener.

getDefaultWidth()

int juce::FileChooserDialogBox::getDefaultWidth ( ) const

private

okButtonPressed()

void juce::FileChooserDialogBox::okButtonPressed ( )

private

okToOverwriteFileCallback()

void juce::FileChooserDialogBox::okToOverwriteFileCallback ( int result, FileChooserDialogBox * box )

staticprivate

selectionChanged()

void juce::FileChooserDialogBox::selectionChanged ( )

overrideprivatevirtual

Callback when the user selects a different file in the browser.

Implements juce::FileBrowserListener.

Member Data Documentation

content

ContentComponent* juce::FileChooserDialogBox::content

private

warnAboutOverwritingExistingFiles

const bool juce::FileChooserDialogBox::warnAboutOverwritingExistingFiles

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/filebrowser/juce_FileChooserDialogBox.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.cpp