JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FileBrowserComponent Class Reference

A component for browsing and selecting a file or directory to open or save. More...

Inherits Component, FileBrowserListener, TextEditor::Listener, ButtonListener, ComboBox::Listener, and FileFilter.

Classes

struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes to provide various file-browser layout and drawing methods. More...
 

Public Types

enum  FileChooserFlags {
  openMode = 1, saveMode = 2, canSelectFiles = 4, canSelectDirectories = 8,
  canSelectMultipleItems = 16, useTreeView = 32, filenameBoxIsReadOnly = 64, warnAboutOverwriting = 128
}
 Various options for the browser. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 FileBrowserComponent (int flags, const File &initialFileOrDirectory, const FileFilter *fileFilter, FilePreviewComponent *previewComp)
 Creates a FileBrowserComponent.
 
 ~FileBrowserComponent ()
 Destructor.
 
int getNumSelectedFiles () const noexcept
 Returns the number of files that the user has got selected.
 
File getSelectedFile (int index) const noexcept
 Returns one of the files that the user has chosen.
 
void deselectAllFiles ()
 Deselects any files that are currently selected.
 
bool currentFileIsValid () const
 Returns true if the currently selected file(s) are usable.
 
File getHighlightedFile () const noexcept
 This returns the last item in the view that the user has highlighted.
 
const FilegetRoot () const
 Returns the directory whose contents are currently being shown in the listbox.
 
void setRoot (const File &newRootDirectory)
 Changes the directory that's being shown in the listbox.
 
void setFileName (const String &newName)
 Changes the name that is currently shown in the filename box.
 
void goUp ()
 Equivalent to pressing the "up" button to browse the parent directory.
 
void refresh ()
 Refreshes the directory that's currently being listed.
 
void setFileFilter (const FileFilter *newFileFilter)
 Changes the filter that's being used to sift the files.
 
virtual String getActionVerb () const
 Returns a verb to describe what should happen when the file is accepted.
 
bool isSaveMode () const noexcept
 Returns true if the saveMode flag was set when this component was created.
 
void setFilenameBoxLabel (const String &name)
 Sets the label that will be displayed next to the filename entry box.
 
void addListener (FileBrowserListener *listener)
 Adds a listener to be told when the user selects and clicks on files.
 
void removeListener (FileBrowserListener *listener)
 Removes a listener.
 
void resized () override
 
void buttonClicked (Button *) override
 
void comboBoxChanged (ComboBox *) override
 
void textEditorTextChanged (TextEditor &) override
 
void textEditorReturnKeyPressed (TextEditor &) override
 
void textEditorEscapeKeyPressed (TextEditor &) override
 
void textEditorFocusLost (TextEditor &) override
 
bool keyPressed (const KeyPress &) override
 
void selectionChanged () override
 
void fileClicked (const File &, const MouseEvent &) override
 
void fileDoubleClicked (const File &) override
 
void browserRootChanged (const File &) override
 
bool isFileSuitable (const File &) const override
 
bool isDirectorySuitable (const File &) const override
 
FilePreviewComponentgetPreviewComponent () const noexcept
 
DirectoryContentsDisplayComponentgetDisplayComponent () const noexcept
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paint (Graphics &g)
 Components can override this method to draw their content.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed.
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
virtual void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 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 ()
 Destructor.
 

Static Public Member Functions

static void getDefaultRoots (StringArray &rootNames, StringArray &rootPaths)
 Returns a platform-specific list of names and paths for some suggested places the user might want to use as root folders.
 
- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 

Protected Member Functions

virtual void getRoots (StringArray &rootNames, StringArray &rootPaths)
 Returns a list of names and paths for the default places the user might want to look.
 
void resetRecentPaths ()
 Updates the items in the dropdown list of recent paths with the values from getRoots().
 

Additional Inherited Members

- Private Member Functions inherited from FileBrowserListener
virtual ~FileBrowserListener ()
 Destructor.
 
- Private Member Functions inherited from TextEditor::Listener
virtual ~Listener ()
 Destructor.
 
- Private Member Functions inherited from ComboBox::Listener
virtual ~Listener ()
 Destructor.
 
- Private Member Functions inherited from FileFilter
 FileFilter (const String &filterDescription)
 Creates a filter with the given description.
 
virtual ~FileFilter ()
 Destructor.
 
const StringgetDescription () const noexcept
 Returns the description that the filter was created with.
 

Detailed Description

A component for browsing and selecting a file or directory to open or save.

This contains a FileListComponent and adds various boxes and controls for navigating and selecting a file. It can work in different modes so that it can be used for loading or saving a file, or for choosing a directory.

See Also
FileChooserDialogBox, FileChooser, FileListComponent

Member Enumeration Documentation

Various options for the browser.

A combination of these is passed into the FileBrowserComponent constructor.

Enumerator:
openMode 

specifies that the component should allow the user to choose an existing file with the intention of opening it.

saveMode 

specifies that the component should allow the user to specify the name of a file that will be used to save something.

canSelectFiles 

specifies that the user can select files (can be used in conjunction with canSelectDirectories).

canSelectDirectories 

specifies that the user can select directories (can be used in conjuction with canSelectFiles).

canSelectMultipleItems 

specifies that the user can select multiple items.

useTreeView 

specifies that a tree-view should be shown instead of a file list.

filenameBoxIsReadOnly 

specifies that the user can't type directly into the filename box.

warnAboutOverwriting 

specifies that the dialog should warn about overwriting existing files (if possible).

Constructor & Destructor Documentation

FileBrowserComponent::FileBrowserComponent ( int  flags,
const File initialFileOrDirectory,
const FileFilter fileFilter,
FilePreviewComponent previewComp 
)

Creates a FileBrowserComponent.

Parameters
flagsA combination of flags from the FileChooserFlags enumeration, used to specify the component's behaviour. The flags must contain either openMode or saveMode, and canSelectFiles and/or canSelectDirectories.
initialFileOrDirectoryThe file or directory that should be selected when the component begins. If this is File::nonexistent, a default directory will be chosen.
fileFilteran optional filter to use to determine which files are shown. If this is nullptr then all files are displayed. Note that a pointer is kept internally to this object, so make sure that it is not deleted before the FileBrowserComponent object is deleted.
previewCompan optional preview component that will be used to show previews of files that the user selects
FileBrowserComponent::~FileBrowserComponent ( )

Destructor.

Member Function Documentation

int FileBrowserComponent::getNumSelectedFiles ( ) const
noexcept

Returns the number of files that the user has got selected.

If multiple select isn't active, this will only be 0 or 1. To get the complete list of files they've chosen, pass an index to getCurrentFile().

File FileBrowserComponent::getSelectedFile ( int  index) const
noexcept

Returns one of the files that the user has chosen.

If the box has multi-select enabled, the index lets you specify which of the files to get - see getNumSelectedFiles() to find out how many files were chosen.

See Also
getHighlightedFile
void FileBrowserComponent::deselectAllFiles ( )

Deselects any files that are currently selected.

bool FileBrowserComponent::currentFileIsValid ( ) const

Returns true if the currently selected file(s) are usable.

This can be used to decide whether the user can press "ok" for the current file. What it does depends on the mode, so for example in an "open" mode, this only returns true if a file has been selected and if it exists. In a "save" mode, a non-existent file would also be valid.

File FileBrowserComponent::getHighlightedFile ( ) const
noexcept

This returns the last item in the view that the user has highlighted.

This may be different from getCurrentFile(), which returns the value that is shown in the filename box, and if there are multiple selections, this will only return one of them.

See Also
getSelectedFile
const File& FileBrowserComponent::getRoot ( ) const

Returns the directory whose contents are currently being shown in the listbox.

void FileBrowserComponent::setRoot ( const File newRootDirectory)

Changes the directory that's being shown in the listbox.

void FileBrowserComponent::setFileName ( const String newName)

Changes the name that is currently shown in the filename box.

void FileBrowserComponent::goUp ( )

Equivalent to pressing the "up" button to browse the parent directory.

void FileBrowserComponent::refresh ( )

Refreshes the directory that's currently being listed.

void FileBrowserComponent::setFileFilter ( const FileFilter newFileFilter)

Changes the filter that's being used to sift the files.

virtual String FileBrowserComponent::getActionVerb ( ) const
virtual

Returns a verb to describe what should happen when the file is accepted.

E.g. if browsing in "load file" mode, this will be "Open", if in "save file" mode, it'll be "Save", etc.

bool FileBrowserComponent::isSaveMode ( ) const
noexcept

Returns true if the saveMode flag was set when this component was created.

void FileBrowserComponent::setFilenameBoxLabel ( const String name)

Sets the label that will be displayed next to the filename entry box.

By default this is just "file", but you might want to change it to something more appropriate for your app.

void FileBrowserComponent::addListener ( FileBrowserListener listener)

Adds a listener to be told when the user selects and clicks on files.

See Also
removeListener
void FileBrowserComponent::removeListener ( FileBrowserListener listener)

Removes a listener.

See Also
addListener
static void FileBrowserComponent::getDefaultRoots ( StringArray rootNames,
StringArray rootPaths 
)
static

Returns a platform-specific list of names and paths for some suggested places the user might want to use as root folders.

The list returned contains empty strings to indicate section breaks.

See Also
getRoots()
void FileBrowserComponent::resized ( )
overridevirtual

Reimplemented from Component.

void FileBrowserComponent::buttonClicked ( Button )
override
void FileBrowserComponent::comboBoxChanged ( ComboBox )
overridevirtual

Implements ComboBox::Listener.

void FileBrowserComponent::textEditorTextChanged ( TextEditor )
overridevirtual

Reimplemented from TextEditor::Listener.

void FileBrowserComponent::textEditorReturnKeyPressed ( TextEditor )
overridevirtual

Reimplemented from TextEditor::Listener.

void FileBrowserComponent::textEditorEscapeKeyPressed ( TextEditor )
overridevirtual

Reimplemented from TextEditor::Listener.

void FileBrowserComponent::textEditorFocusLost ( TextEditor )
overridevirtual

Reimplemented from TextEditor::Listener.

bool FileBrowserComponent::keyPressed ( const KeyPress )
overridevirtual

Reimplemented from Component.

void FileBrowserComponent::selectionChanged ( )
overridevirtual

Implements FileBrowserListener.

void FileBrowserComponent::fileClicked ( const File ,
const MouseEvent  
)
overridevirtual

Implements FileBrowserListener.

void FileBrowserComponent::fileDoubleClicked ( const File )
overridevirtual

Implements FileBrowserListener.

void FileBrowserComponent::browserRootChanged ( const File )
overridevirtual

Implements FileBrowserListener.

bool FileBrowserComponent::isFileSuitable ( const File ) const
overridevirtual

Implements FileFilter.

bool FileBrowserComponent::isDirectorySuitable ( const File ) const
overridevirtual

Implements FileFilter.

FilePreviewComponent* FileBrowserComponent::getPreviewComponent ( ) const
noexcept
DirectoryContentsDisplayComponent* FileBrowserComponent::getDisplayComponent ( ) const
noexcept
virtual void FileBrowserComponent::getRoots ( StringArray rootNames,
StringArray rootPaths 
)
protectedvirtual

Returns a list of names and paths for the default places the user might want to look.

By default this just calls getDefaultRoots(), but you may want to override it to return a custom list.

void FileBrowserComponent::resetRecentPaths ( )
protected

Updates the items in the dropdown list of recent paths with the values from getRoots().


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