Shows a filename as an editable text box, with a 'browse' button and a drop-down list for recently selected files. More...

Inheritance diagram for FilenameComponent:

Classes

struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes. More...
 

Public Member Functions

 FilenameComponent (const String &name, const File &currentFile, bool canEditFilename, bool isDirectory, bool isForSaving, const String &fileBrowserWildcard, const String &enforcedSuffix, const String &textWhenNothingSelected)
 Creates a FilenameComponent. More...
 
 ~FilenameComponent ()
 Destructor. More...
 
File getCurrentFile () const
 Returns the currently displayed filename. More...
 
String getCurrentFileText () const
 Returns the raw text that the user has entered. More...
 
void setCurrentFile (File newFile, bool addToRecentlyUsedList, NotificationType notification=sendNotificationAsync)
 Changes the current filename. More...
 
void setFilenameIsEditable (bool shouldBeEditable)
 Changes whether the use can type into the filename box. More...
 
void setDefaultBrowseTarget (const File &newDefaultDirectory)
 Sets a file or directory to be the default starting point for the browser to show. More...
 
virtual File getLocationToBrowse ()
 This can be overridden to return a custom location that you want the dialog box to show when the browse button is pushed. More...
 
StringArray getRecentlyUsedFilenames () const
 Returns all the entries on the recent files list. More...
 
void setRecentlyUsedFilenames (const StringArray &filenames)
 Sets all the entries on the recent files list. More...
 
void addRecentlyUsedFile (const File &file)
 Adds an entry to the recently-used files dropdown list. More...
 
void setMaxNumberOfRecentFiles (int newMaximum)
 Changes the limit for the number of files that will be stored in the recent-file list. More...
 
void setBrowseButtonText (const String &browseButtonText)
 Changes the text shown on the 'browse' button. More...
 
void addListener (FilenameComponentListener *listener)
 Adds a listener that will be called when the selected file is changed. More...
 
void removeListener (FilenameComponentListener *listener)
 Removes a previously-registered listener. More...
 
void setTooltip (const String &newTooltip) override
 Gives the component a tooltip. More...
 
void paintOverChildren (Graphics &) override
 
void resized () override
 
void lookAndFeelChanged () override
 
bool isInterestedInFileDrag (const StringArray &) override
 
void filesDropped (const StringArray &, int, int) override
 
void fileDragEnter (const StringArray &, int, int) override
 
void fileDragExit (const StringArray &) override
 
KeyboardFocusTraversercreateFocusTraverser () override
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component. More...
 
virtual ~Component ()
 Destructor. More...
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time. More...
 
const StringgetName () const noexcept
 Returns the name of this component. More...
 
virtual void setName (const String &newName)
 Sets the name of this component. More...
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID(). More...
 
void setComponentID (const String &newID)
 Sets the component's ID string. More...
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible. More...
 
bool isVisible () const noexcept
 Tests whether the component is visible or not. More...
 
virtual void visibilityChanged ()
 Called when this component's visibility changes. More...
 
bool isShowing () const
 Tests whether this component and all its parents are visible. More...
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop. More...
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it. More...
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop. More...
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component. More...
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window. More...
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised. More...
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop. More...
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings. More...
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings. More...
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component. More...
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings. More...
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings. More...
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge. More...
 
int getY () const noexcept
 Returns the y coordinate of the top of this component. More...
 
int getWidth () const noexcept
 Returns the component's width in pixels. More...
 
int getHeight () const noexcept
 Returns the component's height in pixels. More...
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge. More...
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point. More...
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component. More...
 
Rectangle< int > getBounds () const noexcept
 Returns this component's bounding box. More...
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin. More...
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers. More...
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin. More...
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin. More...
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left. More...
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left. More...
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space. More...
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space. More...
 
Rectangle< int > getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space. More...
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate. More...
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate. More...
 
Rectangle< int > localAreaToGlobal (Rectangle< int > localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate. More...
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position. More...
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position. More...
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position. More...
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component. More...
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size. More...
 
void setBounds (Rectangle< int > newBounds)
 Changes the component's position and size. More...
 
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. More...
 
void setBoundsInset (BorderSize< int > borders)
 Changes the component's position and size based on the amount of space to leave around it. More...
 
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. More...
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre. More...
 
void setCentrePosition (Point< int > newCentrePosition)
 Changes the position of the component's centre. More...
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre. More...
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent. More...
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component. More...
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component. More...
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component. More...
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width. More...
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height. More...
 
int getParentWidth () const noexcept
 Returns the width of the component's parent. More...
 
int getParentHeight () const noexcept
 Returns the height of the component's parent. More...
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component. More...
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains. More...
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index. More...
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components. More...
 
const Array< Component * > & getChildren () const noexcept
 Provides access to the underlying array of child components. More...
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID. More...
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one. More...
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one. More...
 
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. More...
 
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. More...
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID. More...
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components. More...
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index. More...
 
void removeAllChildren ()
 Removes all this component's children. More...
 
void deleteAllChildren ()
 Removes and deletes all of this component's children. More...
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside. More...
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class. More...
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents. More...
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children. More...
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed. More...
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...
 
virtual bool hitTest (int x, int y)
 Tests whether a given point is inside the component. More...
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method. More...
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags. More...
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children. More...
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one. More...
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one. More...
 
void repaint ()
 Marks the whole component as needing to be redrawn. More...
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn. More...
 
void repaint (Rectangle< int > area)
 Marks a subsection of this component as needing to be redrawn. More...
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing. More...
 
Image createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component. More...
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context. More...
 
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. More...
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance. More...
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect. More...
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component. More...
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component. More...
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children. More...
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent. More...
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent. More...
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked. More...
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on. More...
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not. More...
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus. More...
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus. More...
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component. More...
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus. More...
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings. More...
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified. More...
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed. More...
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed. More...
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container. More...
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled. More...
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component. More...
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled. More...
 
float getAlpha () const noexcept
 Returns the component's current transparancy level. More...
 
void setAlpha (float newAlpha)
 Changes the transparency of this component. More...
 
virtual void alphaChanged ()
 Called when setAlpha() is used to change the alpha value of this component. More...
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component. More...
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component. More...
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated. More...
 
virtual void paint (Graphics &g)
 Components can override this method to draw their content. More...
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component. More...
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component. More...
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component. More...
 
virtual void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed. More...
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down. More...
 
virtual void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released. More...
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component. More...
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved. More...
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used. More...
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component. More...
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component. More...
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener. More...
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives. More...
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener. More...
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed. More...
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released. More...
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released. More...
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus. More...
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus. More...
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component. More...
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component. More...
 
bool isMouseOverOrDragging (bool includeChildren=false) const
 True if the mouse is over this component, or if it's being dragged in this component. More...
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component. More...
 
virtual void moved ()
 Called when this component's position has been changed. More...
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized. More...
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized. More...
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings. More...
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position. More...
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener. More...
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component. More...
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage(). More...
 
int runModalLoop ()
 Runs a component modally, waiting until the loop terminates. More...
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Puts the component into a modal state. More...
 
void exitModalState (int returnValue)
 Ends a component's modal state. More...
 
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
 Returns true if this component is the modal one. More...
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events. More...
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component. More...
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component. More...
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component. More...
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number. More...
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose. More...
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it. More...
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...
 
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. More...
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method. More...
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList. More...
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component. More...
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component. More...
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component. More...
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting. More...
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage(). More...
 
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
 Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled. More...
 
bool getViewportIgnoreDragFlag () const noexcept
 Retrieves the current state of the Viewport drag-to-scroll functionality flag. More...
 
 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)
 
 JUCE_DEPRECATED (void setBounds(const RelativeRectangle &))
 
 JUCE_DEPRECATED (void setBounds(const String &))
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor. More...
 
- Public Member Functions inherited from SettableTooltipClient
 ~SettableTooltipClient ()
 Destructor. More...
 
String getTooltip () override
 Returns the tooltip assigned to this object. More...
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor. More...
 
- Public Member Functions inherited from FileDragAndDropTarget
virtual ~FileDragAndDropTarget ()
 Destructor. More...
 
virtual void fileDragMove (const StringArray &files, int x, int y)
 Callback to indicate that the user is dragging some files over this component. More...
 

Additional Inherited Members

- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 
- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus. More...
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it. More...
 
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. More...
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down. More...
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state. More...
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal. More...
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

Detailed Description

Shows a filename as an editable text box, with a 'browse' button and a drop-down list for recently selected files.

A handy component for dialogue boxes where you want the user to be able to select a file or directory.

Attach an FilenameComponentListener using the addListener() method, and it will get called each time the user changes the filename, either by browsing for a file and clicking 'ok', or by typing a new filename into the box and pressing return.

See also
FileChooser, ComboBox

Constructor & Destructor Documentation

◆ FilenameComponent()

FilenameComponent::FilenameComponent ( const String name,
const File currentFile,
bool  canEditFilename,
bool  isDirectory,
bool  isForSaving,
const String fileBrowserWildcard,
const String enforcedSuffix,
const String textWhenNothingSelected 
)

Creates a FilenameComponent.

Parameters
namethe name for this component.
currentFilethe file to initially show in the box
canEditFilenameif true, the user can manually edit the filename; if false, they can only change it by browsing for a new file
isDirectoryif true, the file will be treated as a directory, and an appropriate directory browser used
isForSavingif true, the file browser will allow non-existent files to be picked, as the file is assumed to be used for saving rather than loading
fileBrowserWildcarda wildcard pattern to use in the file browser - e.g. "*.txt;*.foo". If an empty string is passed in, then the pattern is assumed to be "*"
enforcedSuffixif this is non-empty, it is treated as a suffix that will be added to any filenames that are entered or chosen
textWhenNothingSelectedthe message to display in the box before any filename is entered. (This will only appear if the initial file isn't valid)

◆ ~FilenameComponent()

FilenameComponent::~FilenameComponent ( )

Destructor.

Member Function Documentation

◆ getCurrentFile()

File FilenameComponent::getCurrentFile ( ) const

Returns the currently displayed filename.

◆ getCurrentFileText()

String FilenameComponent::getCurrentFileText ( ) const

Returns the raw text that the user has entered.

◆ setCurrentFile()

void FilenameComponent::setCurrentFile ( File  newFile,
bool  addToRecentlyUsedList,
NotificationType  notification = sendNotificationAsync 
)

Changes the current filename.

Parameters
newFilethe new filename to use
addToRecentlyUsedListif true, the filename will also be added to the drop-down list of recent files.
notificationwhether to send a notification of the change to listeners

◆ setFilenameIsEditable()

void FilenameComponent::setFilenameIsEditable ( bool  shouldBeEditable)

Changes whether the use can type into the filename box.

◆ setDefaultBrowseTarget()

void FilenameComponent::setDefaultBrowseTarget ( const File newDefaultDirectory)

Sets a file or directory to be the default starting point for the browser to show.

This is only used if the current file hasn't been set.

◆ getLocationToBrowse()

virtual File FilenameComponent::getLocationToBrowse ( )
virtual

This can be overridden to return a custom location that you want the dialog box to show when the browse button is pushed.

The default implementation of this method will return either the current file (if one has been chosen) or the location that was set by setDefaultBrowseTarget().

◆ getRecentlyUsedFilenames()

StringArray FilenameComponent::getRecentlyUsedFilenames ( ) const

Returns all the entries on the recent files list.

This can be used in conjunction with setRecentlyUsedFilenames() for saving the state of this list.

See also
setRecentlyUsedFilenames

◆ setRecentlyUsedFilenames()

void FilenameComponent::setRecentlyUsedFilenames ( const StringArray filenames)

Sets all the entries on the recent files list.

This can be used in conjunction with getRecentlyUsedFilenames() for saving the state of this list.

See also
getRecentlyUsedFilenames, addRecentlyUsedFile

◆ addRecentlyUsedFile()

void FilenameComponent::addRecentlyUsedFile ( const File file)

Adds an entry to the recently-used files dropdown list.

If the file is already in the list, it will be moved to the top. A limit is also placed on the number of items that are kept in the list.

See also
getRecentlyUsedFilenames, setRecentlyUsedFilenames, setMaxNumberOfRecentFiles

◆ setMaxNumberOfRecentFiles()

void FilenameComponent::setMaxNumberOfRecentFiles ( int  newMaximum)

Changes the limit for the number of files that will be stored in the recent-file list.

◆ setBrowseButtonText()

void FilenameComponent::setBrowseButtonText ( const String browseButtonText)

Changes the text shown on the 'browse' button.

By default this button just says "..." but you can change it. The button itself can be changed using the look-and-feel classes, so it might not actually have any text on it.

◆ addListener()

void FilenameComponent::addListener ( FilenameComponentListener listener)

Adds a listener that will be called when the selected file is changed.

◆ removeListener()

void FilenameComponent::removeListener ( FilenameComponentListener listener)

Removes a previously-registered listener.

◆ setTooltip()

void FilenameComponent::setTooltip ( const String newTooltip)
overridevirtual

Gives the component a tooltip.

Reimplemented from SettableTooltipClient.

◆ paintOverChildren()

void FilenameComponent::paintOverChildren ( Graphics )
overridevirtual

Reimplemented from Component.

◆ resized()

void FilenameComponent::resized ( )
overridevirtual

Reimplemented from Component.

◆ lookAndFeelChanged()

void FilenameComponent::lookAndFeelChanged ( )
overridevirtual

Reimplemented from Component.

◆ isInterestedInFileDrag()

bool FilenameComponent::isInterestedInFileDrag ( const StringArray )
overridevirtual

Implements FileDragAndDropTarget.

◆ filesDropped()

void FilenameComponent::filesDropped ( const StringArray ,
int  ,
int   
)
overridevirtual

Implements FileDragAndDropTarget.

◆ fileDragEnter()

void FilenameComponent::fileDragEnter ( const StringArray ,
int  ,
int   
)
overridevirtual

Reimplemented from FileDragAndDropTarget.

◆ fileDragExit()

void FilenameComponent::fileDragExit ( const StringArray )
overridevirtual

Reimplemented from FileDragAndDropTarget.

◆ createFocusTraverser()

KeyboardFocusTraverser* FilenameComponent::createFocusTraverser ( )
overridevirtual

Reimplemented from Component.


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