Skip to content

Commit

Permalink
DOC: Update ctkFileDialog docstring to describe behavior as native di…
Browse files Browse the repository at this point in the history
…alog
  • Loading branch information
jcfr committed Jan 13, 2024
1 parent cccd1d1 commit 6c7f5e0
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions Libs/Widgets/ctkFileDialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,20 @@ class ctkFileDialogPrivate;

/// \ingroup Widgets
/// Customizable QFileDialog.
/// An extra widget can be added at the bottom of the dialog
/// under the file format combobox. The Accept button is also controllable
/// using setAcceptButtonEnable().
///
/// This widget allows customization of QFileDialog with the option to add
/// an extra widget at the bottom, below the file format combobox. The Accept
/// button's behavior can be controlled using setAcceptButtonEnable()
///
/// The behavior of the "return" key is the following:
/// - it selects the directory written in the line edit or it
/// - it accepts the dialog if the directory is already selected.
///
/// \warning The ability to set a bottom widget and selection mode is supported
/// only if either the application attribute Qt::AA_DontUseNativeDialogs or the
/// dialog attribute ctkFileDialog::DontUseNativeDialog is set. By default, native
/// dialogs are used.
///
class CTK_WIDGETS_EXPORT ctkFileDialog : public QFileDialog
{
Q_OBJECT
Expand Down

0 comments on commit 6c7f5e0

Please sign in to comment.