Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# FileSelector Class Reference

The FileSelector widget allows the user to select DocLnk objects. More...

`#include <qtopia/fileselector.h>`

List of all member functions.

## Public Members

- FileSelector ( const QString & f, QWidget * parent, const char * name = 0, bool newVisible = TRUE, bool closeVisible = TRUE )
- ~FileSelector ()
- void setNewVisible ( bool b )
- void setCloseVisible ( bool b )
- int fileCount ()
- DocLnk selectedDocument () const
- QValueList<DocLnk> fileList () const
- void setCurrentCategory ( int newCatUid )
- void reread ()
- enum SortMode { Alphabetical, ReverseAlphabetical, Chronological, ReverseChronological }
- void setSortMode ( SortMode m )
- void addOptions ( QPopupMenu * m )

## Signals

- void fileSelected ( const DocLnk & f )
- void newSelected ( const DocLnk & f )
- void closeMe ()
- void typeChanged ( void )
- void categoryChanged ( void )

## Detailed Description

The FileSelector widget allows the user to select DocLnk objects.

This class presents a file selection dialog to the user. This widget is usually the first widget seen in a document-oriented application. The developer will most often create this widget in combination with a QWidgetStack and the appropriate editor and/or viewer widget for their application. This widget should be shown first and the user can the select which document they wish to operate on. Please refer to the implementation of texteditor for an example of how to tie these classes together.

Use setNewVisible() depending on whether the application can be used to create new files or not. Use setCloseVisible() depending on whether the user may leave the dialog without creating or selecting a document or not. The number of files in the view is available from fileCount(). To force the view to be updated call reread().

If the user presses the 'New' button the newSelected() signal is emitted. If the user selects an existing file the fileSelected() signal is emitted. The selected file's DocLnk is available from the selected() function. If the file selector is no longer necessary the closeMe() signal is emitted.

The typeChanged() and categoryChanged() signals are emitted when either a different file type or category are selected. Note that in Qtopia 1.5.0, there were no selectors for this, so these signals are never emitted on that platform.

See also FileManager and Qtopia Classes.

## Member Function Documentation

### FileSelector::FileSelector ( const QString & f, QWidget * parent, const char * name = 0, bool newVisible = TRUE, bool closeVisible = TRUE )

Constructs a FileSelector with mime filter f. The standard Qt parent and name parameters are passed to the parent widget.

If newVisible is TRUE, the widget has a button to allow the user the create "new" documents; this is useful for applications that can create and edit documents but not suitable for applications that only provide viewing.

closeVisible is deprecated

See also DocLnkSet::DocLnkSet().

### FileSelector::~FileSelector ()

Destroys the widget.

### void FileSelector::categoryChanged ( void )`[signal]`

This signal is emitted when a different category is selected.

### void FileSelector::closeMe ()`[signal]`

This signal is emitted when the user no longer needs to view the widget.

### int FileSelector::fileCount ()

Returns the number of files in the view. If this is zero, an editor application might bypass the selector and immediately start with a "new" document.

### QValueList<DocLnk> FileSelector::fileList () const

Returns a list of all documents.

First availability: Qtopia 1.6

### void FileSelector::fileSelected ( const DocLnk & f )`[signal]`

This signal is emitted when the user selects a document. f is the document.

### void FileSelector::newSelected ( const DocLnk & f )`[signal]`

This signal is emitted when the user selects a "new" document. f is a DocLnk for the document. You will need to set the type of the document after copying it.

### void FileSelector::reread ()

Rereads the list of documents.

### DocLnk FileSelector::selectedDocument () const

Returns the selected DocLnk, or a null DocLnk is none is selected.

First availability: Qtopia 1.6

### void FileSelector::setCloseVisible ( bool b )

If b is TRUE a "close" or "no document" button is visible; if b is FALSE this button is not visible and the user is unable to leave the dialog without creating or selecting a document.

This function is deprecated.

### void FileSelector::setCurrentCategory ( int newCatUid )

Set the selected category to newCatUid.

First availability: Qtopia 2.1

### void FileSelector::setNewVisible ( bool b )

If b is TRUE a "new document" entry is visible; if b is FALSE this entry is not visible and the user is unable to create new documents from the dialog.

### void FileSelector::typeChanged ( void )`[signal]`

This signal is emitted when a different file type is selected.

This file is part of the Qtopia platform, copyright © 1995-2004 Trolltech, all rights reserved.