/////////////////////////////////////////////////////////////////////////////
// Name: filepicker.h
-// Purpose: documentation for wxFilePickerCtrl class
+// Purpose: interface of wxFilePickerCtrl
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxFilePickerCtrl
@wxheader{filepicker.h}
-
+
This control allows the user to select a file. The generic implementation is
a button which brings up a wxFileDialog when clicked. Native implementation
may differ but this is usually a (small) widget which give access to the
file-chooser
dialog.
It is only available if @c wxUSE_FILEPICKERCTRL is set to 1 (the default).
-
+
@beginStyleTable
- @style{wxFLP_DEFAULT_STYLE}:
+ @style{wxFLP_DEFAULT_STYLE}
The default style: includes wxFLP_OPEN | wxFLP_FILE_MUST_EXIST and,
under wxMSW only, wxFLP_USE_TEXTCTRL.
- @style{wxFLP_USE_TEXTCTRL}:
+ @style{wxFLP_USE_TEXTCTRL}
Creates a text control to the left of the picker button which is
completely managed by the wxFilePickerCtrl and which can be used by
the user to specify a path (see SetPath). The text control is
automatically synchronized with button's value. Use functions
defined in wxPickerBase to modify the text control.
- @style{wxFLP_OPEN}:
+ @style{wxFLP_OPEN}
Creates a picker which allows the user to select a file to open.
- @style{wxFLP_SAVE}:
+ @style{wxFLP_SAVE}
Creates a picker which allows the user to select a file to save.
- @style{wxFLP_OVERWRITE_PROMPT}:
+ @style{wxFLP_OVERWRITE_PROMPT}
Can be combined with wxFLP_SAVE only: ask confirmation to the user
before selecting a file.
- @style{wxFLP_FILE_MUST_EXIST}:
+ @style{wxFLP_FILE_MUST_EXIST}
Can be combined with wxFLP_OPEN only: the selected file must be an
existing file.
- @style{wxFLP_CHANGE_DIR}:
+ @style{wxFLP_CHANGE_DIR}
Change current working directory on each user file selection change.
@endStyleTable
-
+
@library{wxcore}
- @category{miscpickers}
+ @category{pickers}
@appearance{filepickerctrl.png}
-
- @seealso
- wxFileDialog, wxFileDirPickerEvent
+
+ @see wxFileDialog, wxFileDirPickerEvent
*/
class wxFilePickerCtrl : public wxPickerBase
{
Initializes the object and calls Create() with
all the parameters.
*/
- wxFilePickerCtrl(wxWindow * parent, wxWindowID id,
+ wxFilePickerCtrl(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& message = "Select a file",
const wxString& wildcard = ".",
const wxString& name = "filepickerctrl");
/**
- @param parent
- Parent window, must not be non-@NULL.
-
- @param id
- The identifier for the control.
-
- @param path
- The initial file shown in the control. Must be a valid path to a file or the
- empty string.
-
- @param message
- The message shown to the user in the wxFileDialog shown by the control.
-
- @param wildcard
- A wildcard which defines user-selectable files (use the same syntax as for
+ @param parent
+ Parent window, must not be non-@NULL.
+ @param id
+ The identifier for the control.
+ @param path
+ The initial file shown in the control. Must be a valid path to a file or
+ the empty string.
+ @param message
+ The message shown to the user in the wxFileDialog shown by the control.
+ @param wildcard
+ A wildcard which defines user-selectable files (use the same syntax as for
wxFileDialog's wildcards).
-
- @param pos
- Initial position.
-
- @param size
- Initial size.
-
- @param style
- The window style, see wxFLP_* flags.
-
- @param validator
- Validator which can be used for additional date checks.
-
- @param name
- Control name.
-
+ @param pos
+ Initial position.
+ @param size
+ Initial size.
+ @param style
+ The window style, see wxFLP_* flags.
+ @param validator
+ Validator which can be used for additional date checks.
+ @param name
+ Control name.
+
@returns @true if the control was successfully created or @false if
- creation failed.
+ creation failed.
*/
- bool Create(wxWindow * parent, wxWindowID id,
+ bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& message = "Select a file",
const wxString& wildcard = ".",
Similar to GetPath() but returns the path of
the currently selected file as a wxFileName object.
*/
- wxFileName GetFileName();
+ wxFileName GetFileName() const;
/**
Returns the absolute path of the currently selected file.
*/
- wxString GetPath();
+ wxString GetPath() const;
/**
This method does the same thing as SetPath() but
takes a wxFileName object instead of a string.
*/
- void SetFileName(const wxFileName & filename);
+ void SetFileName(const wxFileName& filename);
/**
Sets the absolute path of the currently selected file. This must be a valid
file if
the @c wxFLP_FILE_MUST_EXIST style was given.
*/
- void SetPath(const wxString & filename);
+ void SetPath(const wxString& filename);
};
+
/**
@class wxDirPickerCtrl
@wxheader{filepicker.h}
-
+
This control allows the user to select a directory. The generic implementation
is
a button which brings up a wxDirDialog when clicked. Native implementation
dir-chooser
dialog.
It is only available if @c wxUSE_DIRPICKERCTRL is set to 1 (the default).
-
+
@beginStyleTable
- @style{wxDIRP_DEFAULT_STYLE}:
+ @style{wxDIRP_DEFAULT_STYLE}
The default style: includes wxDIRP_DIR_MUST_EXIST and, under wxMSW
only, wxDIRP_USE_TEXTCTRL.
- @style{wxDIRP_USE_TEXTCTRL}:
+ @style{wxDIRP_USE_TEXTCTRL}
Creates a text control to the left of the picker button which is
completely managed by the wxDirPickerCtrl and which can be used by
the user to specify a path (see SetPath). The text control is
automatically synchronized with button's value. Use functions
defined in wxPickerBase to modify the text control.
- @style{wxDIRP_DIR_MUST_EXIST}:
+ @style{wxDIRP_DIR_MUST_EXIST}
Creates a picker which allows to select only existing directories.
wxGTK control always adds this flag internally as it does not
support its absence.
- @style{wxDIRP_CHANGE_DIR}:
+ @style{wxDIRP_CHANGE_DIR}
Change current working directory on each user directory selection
change.
@endStyleTable
-
+
@library{wxcore}
- @category{miscpickers}
+ @category{pickers}
@appearance{dirpickerctrl.png}
-
- @seealso
- wxDirDialog, wxFileDirPickerEvent
+
+ @see wxDirDialog, wxFileDirPickerEvent
*/
class wxDirPickerCtrl : public wxPickerBase
{
Initializes the object and calls Create() with
all the parameters.
*/
- wxDirPickerCtrl(wxWindow * parent, wxWindowID id,
+ wxDirPickerCtrl(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& message = "Select a folder",
const wxPoint& pos = wxDefaultPosition,
const wxString& name = "dirpickerctrl");
/**
- @param parent
- Parent window, must not be non-@NULL.
-
- @param id
- The identifier for the control.
-
- @param path
- The initial directory shown in the control. Must be a valid path to a directory
- or the empty string.
-
- @param message
- The message shown to the user in the wxDirDialog shown by the control.
-
- @param pos
- Initial position.
-
- @param size
- Initial size.
-
- @param style
- The window style, see wxDIRP_* flags.
-
- @param validator
- Validator which can be used for additional date checks.
-
- @param name
- Control name.
-
+ @param parent
+ Parent window, must not be non-@NULL.
+ @param id
+ The identifier for the control.
+ @param path
+ The initial directory shown in the control. Must be a valid path to a
+ directory or the empty string.
+ @param message
+ The message shown to the user in the wxDirDialog shown by the control.
+ @param pos
+ Initial position.
+ @param size
+ Initial size.
+ @param style
+ The window style, see wxDIRP_* flags.
+ @param validator
+ Validator which can be used for additional date checks.
+ @param name
+ Control name.
+
@returns @true if the control was successfully created or @false if
- creation failed.
+ creation failed.
*/
- bool Create(wxWindow * parent, wxWindowID id,
+ bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& message = "Select a folder",
const wxPoint& pos = wxDefaultPosition,
object.
This function is equivalent to GetPath()
*/
- wxFileName GetDirName();
+ wxFileName GetDirName() const;
/**
Returns the absolute path of the currently selected directory.
*/
- wxString GetPath();
+ wxString GetPath() const;
/**
Just like SetPath() but this function takes a
wxFileName object.
*/
- void SetDirName(const wxFileName & dirname);
+ void SetDirName(const wxFileName& dirname);
/**
Sets the absolute path of (the default converter uses current locale's
charset)the currently selected directory. This must be a valid directory if
@c wxDIRP_DIR_MUST_EXIST style was given.
*/
- void SetPath(const wxString & dirname);
+ void SetPath(const wxString& dirname);
};
+
/**
@class wxFileDirPickerEvent
@wxheader{filepicker.h}
-
+
This event class is used for the events generated by
wxFilePickerCtrl and by wxDirPickerCtrl.
-
+
@library{wxcore}
@category{FIXME}
-
- @seealso
- wxfilepickerctrl
+
+ @see wxfilepickerctrl()
*/
class wxFileDirPickerEvent : public wxCommandEvent
{
/**
The constructor is not normally used by the user code.
*/
- wxFileDirPickerEvent(wxEventType type, wxObject * generator,
+ wxFileDirPickerEvent(wxEventType type, wxObject* generator,
int id,
const wxString path);
/**
Retrieve the absolute path of the file/directory the user has just selected.
*/
- wxString GetPath();
+ wxString GetPath() const;
/**
Set the absolute path of the file/directory associated with the event.
*/
- void SetPath(const wxString & path);
+ void SetPath(const wxString& path);
};
+
projects / wxWidgets.git / blobdiff