1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-02-02 03:20:06 +00:00

Updated the API documentation

This commit is contained in:
Julian Storer 2009-12-20 16:01:35 +00:00
parent 796848eb8b
commit 9e53cdc78e
9 changed files with 58 additions and 48 deletions

View file

@ -61,22 +61,26 @@ public:
*/
enum FileChooserFlags
{
openMode = 1, /**< the component should allow the user to choose an existing
file with the intention of opening it. */
saveMode = 2, /**< the component should allow the user to specify the name of
a file that will be used to save something. */
canSelectFiles = 4, /**< */
canSelectDirectories = 8, /**< */
canSelectMultipleItems = 16, /**< */
useTreeView = 32, /**< */
filenameBoxIsReadOnly = 64 /**< */
openMode = 1, /**< specifies that the component should allow the user to
choose an existing file with the intention of opening it. */
saveMode = 2, /**< specifies that the component should allow the user to specify
the name of a file that will be used to save something. */
canSelectFiles = 4, /**< specifies that the user can select files (can be used in
conjunction with canSelectDirectories). */
canSelectDirectories = 8, /**< specifies that the user can select directories (can be used in
conjuction with canSelectFiles). */
canSelectMultipleItems = 16, /**< specifies that the user can select multiple items. */
useTreeView = 32, /**< specifies that a tree-view should be shown instead of a file list. */
filenameBoxIsReadOnly = 64 /**< specifies that the user can't type directly into the filename box. */
};
//==============================================================================
/** Creates a FileBrowserComponent.
@param browserMode The intended purpose for the browser - see the
FileChooserMode enum for the various options
@param 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.
@param initialFileOrDirectory The file or directory that should be selected when
the component begins. If this is File::nonexistent,
a default directory will be chosen.
@ -87,10 +91,6 @@ public:
is deleted.
@param previewComp an optional preview component that will be used to
show previews of files that the user selects
@param useTreeView if this is false, the files are shown in a list; if true,
they are shown in a treeview
@param filenameTextBoxIsReadOnly if true, the user won't be allowed to type their own
text into the filename box.
*/
FileBrowserComponent (int flags,
const File& initialFileOrDirectory,