#include <juce_FileChooserDialogBox.h>

Inheritance diagram for FileChooserDialogBox:

Classes
class	ContentComponent

Public Types
enum	ColourIds { titleTextColourId = 0x1000850 }

Public Types inherited from ResizableWindow
enum	ColourIds { backgroundColourId = 0x1005700 }

Public Types inherited from Component
enum	FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }

Public Member Functions
	FileChooserDialogBox (const String &title, const String &instructions, FileBrowserComponent &browserComponent, bool warnAboutOverwritingExistingFiles, Colour backgroundColour)

	~FileChooserDialogBox ()

void	centreWithDefaultSize (Component *componentToCentreAround=nullptr)

Public Member Functions inherited from ResizableWindow
	ResizableWindow (const String &name, bool addToDesktop)

	ResizableWindow (const String &name, Colour backgroundColour, bool addToDesktop)

	~ResizableWindow ()

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 > &bounds)

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 ()

	JUCE_DEPRECATED (void setContentComponent(Component *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false))

Public Member Functions inherited from TopLevelWindow
	TopLevelWindow (const String &name, bool addToDesktop)

	~TopLevelWindow ()

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 Component
	Component () noexcept

virtual	~Component ()

	Component (const String &componentName) noexcept

const String &	getName () const noexcept

virtual void	setName (const String &newName)

const 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 shouldAlsoGainFocus)

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

const 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, const Rectangle< int > &areaRelativeToSourceComponent) const

Point< int >	localPointToGlobal (Point< int > localPoint) const

Point< float >	localPointToGlobal (Point< float > localPoint) const

Rectangle< int >	localAreaToGlobal (const Rectangle< int > &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 (const Rectangle< int > &newBounds)

void	setBounds (const RelativeRectangle &newBounds)

void	setBounds (const String &newBoundsExpression)

void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)

void	setBoundsInset (const BorderSize< int > &borders)

void	setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)

void	setCentrePosition (int x, int y)

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

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	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)

Component *	getComponentAt (int x, int y)

Component *	getComponentAt (Point< int > position)

void	repaint ()

void	repaint (int x, int y, int width, int height)

void	repaint (const Rectangle< int > &area)

void	setBufferedToImage (bool shouldBeBuffered)

Image	createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)

void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)

void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) 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	setWantsKeyboardFocus (bool wantsFocus) noexcept

bool	getWantsKeyboardFocus () const noexcept

void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)

bool	getMouseClickGrabsKeyboardFocus () const noexcept

void	grabKeyboardFocus ()

bool	hasKeyboardFocus (bool trueIfChildIsFocused) const

void	moveKeyboardFocusToSibling (bool moveToNext)

virtual KeyboardFocusTraverser *	createFocusTraverser ()

int	getExplicitFocusOrder () const

void	setExplicitFocusOrder (int newFocusOrderIndex)

void	setFocusContainer (bool shouldBeFocusContainer) noexcept

bool	isFocusContainer () const noexcept

bool	isEnabled () const noexcept

void	setEnabled (bool shouldBeEnabled)

virtual void	enablementChanged ()

void	setAlpha (float newAlpha)

float	getAlpha () const

void	setMouseCursor (const MouseCursor &cursorType)

virtual MouseCursor	getMouseCursor ()

void	updateMouseCursor () const

virtual void	paintOverChildren (Graphics &g)

virtual void	mouseMove (const MouseEvent &event) override

virtual void	mouseEnter (const MouseEvent &event) override

virtual void	mouseExit (const MouseEvent &event) override

virtual void	mouseDoubleClick (const MouseEvent &event) override

virtual void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override

virtual void	mouseMagnify (const MouseEvent &event, float scaleFactor)

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 () const

bool	isMouseOverOrDragging () 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 () 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 ()

virtual MarkerList *	getMarkers (bool xAxis)

void *	getWindowHandle () const

Positioner *	getPositioner () const noexcept

void	setPositioner (Positioner *newPositioner)

void	setCachedComponentImage (CachedComponentImage *newCachedImage)

CachedComponentImage *	getCachedComponentImage () const noexcept

	JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)

	JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)

	JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

Additional Inherited Members
Static Public Member Functions inherited from TopLevelWindow
static int	getNumTopLevelWindows () noexcept

static TopLevelWindow *	getTopLevelWindow (int index) noexcept

static TopLevelWindow *	getActiveTopLevelWindow () noexcept

Static Public Member Functions inherited from Component
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 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

Protected Member Functions inherited from TopLevelWindow
void	focusOfChildComponentChanged (FocusChangeType) override

void	parentHierarchyChanged () override

void	recreateDesktopWindow ()

void	visibilityChanged () override

Protected Member Functions inherited from Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)

Protected Attributes inherited from ResizableWindow
ScopedPointer< ResizableCornerComponent >	resizableCorner

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

To use one of these, create it and call its show() method. e.g.

{
    WildcardFileFilter wildcardFilter ("*.foo", String::empty, "Foo files");
    FileBrowserComponent browser (FileBrowserComponent::canSelectFiles,
                                  File::nonexistent,
                                  &wildcardFilter,
                                  nullptr);
    FileChooserDialogBox dialogBox ("Open some kind of file",
                                    "Please choose some kind of file that you want to open...",
                                    browser,
                                    false,
                                    Colours::lightgrey);
    if (dialogBox.show())
    {
        File selectedFile = browser.getSelectedFile (0);
        ...etc..
    }
}

See also: FileChooser

Member Enumeration Documentation

◆ ColourIds

enum 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()

FileChooserDialogBox::FileChooserDialogBox	(	const String &	title,
		const String &	instructions,
		FileBrowserComponent &	browserComponent,
		bool	warnAboutOverwritingExistingFiles,
		Colour	backgroundColour
	)

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

See also: FileBrowserComponent, FilePreviewComponent

◆ ~FileChooserDialogBox()

FileChooserDialogBox::~FileChooserDialogBox ( )

Destructor.

Member Function Documentation

◆ centreWithDefaultSize()

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

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Additional Inherited Members