openshot-audio
0.1.6
|
#include <juce_gui_basics.h>
Classes | |
struct | LookAndFeelMethods |
Public Types | |
enum | FileChooserFlags { openMode = 1, saveMode = 2, canSelectFiles = 4, canSelectDirectories = 8, canSelectMultipleItems = 16, useTreeView = 32, filenameBoxIsReadOnly = 64, warnAboutOverwriting = 128, doNotClearFileNameOnRootChange = 256 } |
![]() | |
enum | FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly } |
Static Public Member Functions | |
static void | getDefaultRoots (StringArray &rootNames, StringArray &rootPaths) |
![]() | |
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 | |
virtual void | getRoots (StringArray &rootNames, StringArray &rootPaths) |
void | resetRecentPaths () |
![]() | |
virtual ComponentPeer * | createNewPeer (int styleFlags, void *nativeWindowToAttachTo) |
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.
Various options for the browser.
A combination of these is passed into the FileBrowserComponent constructor.
FileBrowserComponent::FileBrowserComponent | ( | int | flags, |
const File & | initialFileOrDirectory, | ||
const FileFilter * | fileFilter, | ||
FilePreviewComponent * | previewComp | ||
) |
Creates a FileBrowserComponent.
flags | A 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. |
initialFileOrDirectory | The file or directory that should be selected when the component begins. If this is File::nonexistent, a default directory will be chosen. |
fileFilter | an 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. |
previewComp | an optional preview component that will be used to show previews of files that the user selects |
FileBrowserComponent::~FileBrowserComponent | ( | ) |
Destructor.
void FileBrowserComponent::addListener | ( | FileBrowserListener * | listener | ) |
Adds a listener to be told when the user selects and clicks on files.
Callback when the browser's root folder changes.
Implements juce::FileBrowserListener.
|
overridevirtual |
Called when the button is clicked.
Implements juce::Button::Listener.
|
overridevirtual |
Called when a ComboBox has its selected item changed.
Implements juce::ComboBox::Listener.
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.
void FileBrowserComponent::deselectAllFiles | ( | ) |
Deselects any files that are currently selected.
|
overridevirtual |
Callback when the user clicks on a file in the browser.
Implements juce::FileBrowserListener.
Callback when the user double-clicks on a file in the browser.
Implements juce::FileBrowserListener.
|
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.
|
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.
|
noexcept |
|
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.
|
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().
|
noexcept |
Returns the directory whose contents are currently being shown in the listbox.
|
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.
|
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.
void FileBrowserComponent::goUp | ( | ) |
Equivalent to pressing the "up" button to browse the parent directory.
Should return true if this directory is suitable for inclusion in whatever context the object is being used.
Implements juce::FileFilter.
Should return true if this file is suitable for inclusion in whatever context the object is being used.
Implements juce::FileFilter.
|
noexcept |
Returns true if the saveMode flag was set when this component was created.
Called when a key is pressed.
When a key is pressed, the component that has the keyboard focus will have this method called. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.
If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, the key will be passed to any KeyListeners that have been registered with this component. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.
The default implementation of this method does nothing and returns false.
Reimplemented from juce::Component.
void FileBrowserComponent::refresh | ( | ) |
Refreshes the directory that's currently being listed.
void FileBrowserComponent::removeListener | ( | FileBrowserListener * | listener | ) |
Removes a listener.
|
protected |
Updates the items in the dropdown list of recent paths with the values from getRoots().
|
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.
Reimplemented from juce::Component.
|
overridevirtual |
Callback when the user selects a different file in the browser.
Implements juce::FileBrowserListener.
void FileBrowserComponent::setFileFilter | ( | const FileFilter * | newFileFilter | ) |
Changes the filter that's being used to sift the files.
Changes the name that is currently shown in the filename box.
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.
Changes the directory that's being shown in the listbox.
|
overridevirtual |
Called when the user presses the escape key.
Reimplemented from juce::TextEditor::Listener.
|
overridevirtual |
Called when the text editor loses focus.
Reimplemented from juce::TextEditor::Listener.
|
overridevirtual |
Called when the user presses the return key.
Reimplemented from juce::TextEditor::Listener.
|
overridevirtual |
Called when the user changes the text in some way.
Reimplemented from juce::TextEditor::Listener.