#include <juce_FilenameComponent.h>
Classes | |
| struct | LookAndFeelMethods |
Private Member Functions | |
| void | handleAsyncUpdate () override |
| void | showChooser () |
| Private Member Functions inherited from juce::AsyncUpdater | |
| AsyncUpdater () | |
| virtual | ~AsyncUpdater () |
| void | triggerAsyncUpdate () |
| void | cancelPendingUpdate () noexcept |
| void | handleUpdateNowIfNeeded () |
| bool | isUpdatePending () const noexcept |
Private Attributes | |
| ComboBox | filenameBox |
| String | lastFilename |
| std::unique_ptr< Button > | browseButton |
| int | maxRecentFiles = 30 |
| bool | isDir |
| bool | isSaving |
| bool | isFileDragOver = false |
| String | wildcard |
| String | enforcedSuffix |
| String | browseButtonText |
| ListenerList< FilenameComponentListener > | listeners |
| File | defaultBrowseFile |
| std::unique_ptr< FileChooser > | chooser |
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
@tags{GUI}
Constructor & Destructor Documentation
◆ FilenameComponent()
| juce::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
-
name the name for this component. currentFile the file to initially show in the box canEditFilename if true, the user can manually edit the filename; if false, they can only change it by browsing for a new file isDirectory if true, the file will be treated as a directory, and an appropriate directory browser used isForSaving if 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 fileBrowserWildcard a 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 "*" enforcedSuffix if this is non-empty, it is treated as a suffix that will be added to any filenames that are entered or chosen textWhenNothingSelected the message to display in the box before any filename is entered. (This will only appear if the initial file isn't valid)
◆ ~FilenameComponent()
|
override |
Destructor.
Member Function Documentation
◆ addListener()
| void juce::FilenameComponent::addListener | ( | FilenameComponentListener * | listener | ) |
Adds a listener that will be called when the selected file is changed.
◆ addRecentlyUsedFile()
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
◆ createKeyboardFocusTraverser()
|
overridevirtual |
Creates a ComponentTraverser object to use to determine the logic by which keyboard focus should be passed from this component.
The default implementation of this method will return an instance of KeyboardFocusTraverser if this component is a keyboard focus container (as determined by the setFocusContainerType() method). If the component isn't a keyboard focus container, then it will recursively call createKeyboardFocusTraverser() on its parents.
If you override this to return a custom traverser object, then this component and all its sub-components will use the new object to make their keyboard focusing decisions.
Reimplemented from juce::Component.
◆ fileDragEnter()
|
overridevirtual |
Callback to indicate that some files are being dragged over this component.
This gets called when the user moves the mouse into this component while dragging.
Use this callback as a trigger to make your component repaint itself to give the user feedback about whether the files can be dropped here or not.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging x the mouse x position, relative to this component y the mouse y position, relative to this component
Reimplemented from juce::FileDragAndDropTarget.
◆ fileDragExit()
|
overridevirtual |
Callback to indicate that the mouse has moved away from this component.
This gets called when the user moves the mouse out of this component while dragging the files.
If you've used fileDragEnter() to repaint your component and give feedback, use this as a signal to repaint it in its normal state.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging
Reimplemented from juce::FileDragAndDropTarget.
◆ filesDropped()
|
overridevirtual |
Callback to indicate that the user has dropped the files onto this component.
When the user drops the files, this get called, and you can use the files in whatever way is appropriate.
Note that after this is called, the fileDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging x the mouse x position, relative to this component y the mouse y position, relative to this component
Implements juce::FileDragAndDropTarget.
◆ getCurrentFile()
| File juce::FilenameComponent::getCurrentFile | ( | ) | const |
Returns the currently displayed filename.
◆ getCurrentFileText()
| String juce::FilenameComponent::getCurrentFileText | ( | ) | const |
Returns the raw text that the user has entered.
◆ 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 juce::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
◆ handleAsyncUpdate()
|
overrideprivatevirtual |
Called back to do whatever your class needs to do.
This method is called by the message thread at the next convenient time after the triggerAsyncUpdate() method has been called.
Implements juce::AsyncUpdater.
◆ isInterestedInFileDrag()
|
overridevirtual |
Callback to check whether this target is interested in the set of files being offered.
Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here, like opening the files to have a look inside them!
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging
- Returns
- true if this component wants to receive the other callbacks regarding this type of object; if it returns false, no other callbacks will be made.
Implements juce::FileDragAndDropTarget.
◆ lookAndFeelChanged()
|
overridevirtual |
Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.
- See also
- sendLookAndFeelChange, getLookAndFeel
Reimplemented from juce::Component.
◆ paintOverChildren()
Components can override this method to draw over the top of their children.
For most drawing operations, it's better to use the normal paint() method, but if you need to overlay something on top of the children, this can be used.
- See also
- paint, Graphics
Reimplemented from juce::Component.
◆ removeListener()
| void juce::FilenameComponent::removeListener | ( | FilenameComponentListener * | listener | ) |
Removes a previously-registered listener.
◆ resized()
|
overridevirtual |
Called when this component's size has been changed.
A component can implement this method to do things such as laying out its child components when its width or height changes.
The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).
If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.
- See also
- moved, setSize
Reimplemented from juce::Component.
◆ setBrowseButtonText()
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.
◆ setCurrentFile()
| void juce::FilenameComponent::setCurrentFile | ( | File | newFile, |
| bool | addToRecentlyUsedList, | ||
| NotificationType | notification = sendNotificationAsync ) |
Changes the current filename.
- Parameters
-
newFile the new filename to use addToRecentlyUsedList if true, the filename will also be added to the drop-down list of recent files. notification whether to send a notification of the change to listeners. A notification will only be sent if the filename has changed.
◆ setDefaultBrowseTarget()
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.
◆ setFilenameIsEditable()
| void juce::FilenameComponent::setFilenameIsEditable | ( | bool | shouldBeEditable | ) |
Changes whether the use can type into the filename box.
◆ setMaxNumberOfRecentFiles()
Changes the limit for the number of files that will be stored in the recent-file list.
◆ setRecentlyUsedFilenames()
| void juce::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
◆ setTooltip()
Gives the component a tooltip.
Reimplemented from juce::SettableTooltipClient.
◆ showChooser()
|
private |
Member Data Documentation
◆ browseButton
|
private |
◆ browseButtonText
|
private |
◆ chooser
|
private |
◆ defaultBrowseFile
|
private |
◆ enforcedSuffix
|
private |
◆ filenameBox
|
private |
◆ isDir
|
private |
◆ isFileDragOver
|
private |
◆ isSaving
|
private |
◆ lastFilename
|
private |
◆ listeners
|
private |
◆ maxRecentFiles
|
private |
◆ wildcard
|
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_FilenameComponent.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.cpp
Generated on for LMMS by
1.16.1