};
// the font flag bits for the new font ctor accepting one combined flags word
-enum
+enum wxFontFlag
{
// no special flags: font with default weight/slant/anti-aliasing
wxFONTFLAG_DEFAULT = 0,
/////////////////////////////////////////////////////////////////////////////
// Name: file.h
-// Purpose: interface of wxTempFile
+// Purpose: interface of wxTempFile, wxFile
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
result in only those files matching the pattern being displayed.
The wildcard may be a specification for multiple types of file with a description
for each, such as:
+ @code
"BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"
+ @endcode
It must be noted that wildcard support in the native Motif file dialog is quite
limited: only one alternative is supported, and it is displayed without the
descriptive test; "BMP files (*.bmp)|*.bmp" is displayed as "*.bmp", and both
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+
+/** The various values for the path format: this mainly affects the path
+ separator but also whether or not the path has the drive part
+ (as under Windows).
+
+ See wxFileName for more info.
+*/
+enum wxPathFormat
+{
+ wxPATH_NATIVE = 0, //!< the path format for the current platform.
+ wxPATH_UNIX,
+ wxPATH_BEOS = wxPATH_UNIX,
+ wxPATH_MAC,
+ wxPATH_DOS,
+ wxPATH_WIN = wxPATH_DOS,
+ wxPATH_OS2 = wxPATH_DOS,
+ wxPATH_VMS,
+
+ wxPATH_MAX //!< Not a valid value for specifying path format
+};
+
+
+/** The kind of normalization to do with the file name: these values can be
+ or'd together to perform several operations at once.
+ See wxFileName::Normalize() for more info.
+*/
+enum wxPathNormalize
+{
+ wxPATH_NORM_ENV_VARS = 0x0001, //!< replace env vars with their values.
+ wxPATH_NORM_DOTS = 0x0002, //!< squeeze all .. and . and prepend cwd.
+ wxPATH_NORM_TILDE = 0x0004, //!< Unix only: replace ~ and ~user.
+ wxPATH_NORM_CASE = 0x0008, //!< if case insensitive => tolower.
+ wxPATH_NORM_ABSOLUTE = 0x0010, //!< make the path absolute.
+ wxPATH_NORM_LONG = 0x0020, //!< make the path the long form.
+ wxPATH_NORM_SHORTCUT = 0x0040, //!< resolve the shortcut, if it is a shortcut.
+ wxPATH_NORM_ALL = 0x00ff & ~wxPATH_NORM_CASE
+};
+
+/**
+ The return value of wxFileName::GetSize() in case of error.
+*/
+wxULongLong wxInvalidSize;
+
+
/**
@class wxFileName
MyMethod( dirname.GetPath() );
@endcode
- The same can be done using the static method wxFileName::DirName:
+ The same can be done using the static method wxFileName::DirName():
@code
wxFileName dirname = wxFileName::DirName( "C:\mydir" );
MyMethod( dirname.GetPath() );
@endcode
- Accordingly, methods dealing with directories or directory names
- like wxFileName::IsDirReadable use
- wxFileName::GetPath whereas methods dealing
- with file names like wxFileName::IsFileReadable
- use wxFileName::GetFullPath.
+ Accordingly, methods dealing with directories or directory names like
+ wxFileName::IsDirReadable() use wxFileName::GetPath() whereas methods dealing
+ with file names like wxFileName::IsFileReadable() use wxFileName::GetFullPath().
- If it is not known wether a string contains a directory name or
- a complete file name (such as when interpreting user input) you need to use
- the static function wxFileName::DirExists
- (or its identical variants wxDir::Exists and
- wxDirExists()) and construct the wxFileName
- instance accordingly. This will only work if the directory actually exists,
- of course:
+ If it is not known wether a string contains a directory name or a complete
+ file name (such as when interpreting user input) you need to use the static
+ function wxFileName::DirExists() (or its identical variants wxDir::Exists() and
+ wxDirExists()) and construct the wxFileName instance accordingly.
+ This will only work if the directory actually exists, of course:
@code
wxString user_input;
fname.Assign( user_input );
@endcode
- These functions allow to examine and modify the individual directories
- of the path:
-
- @li AppendDir()
- @li InsertDir()
- @li GetDirCount()
- @li PrependDir()
- @li RemoveDir()
- @li RemoveLastDir()
-
- To change the components of the file name individually you can use the
- following functions:
-
- @li GetExt()
- @li GetName()
- @li GetVolume()
- @li HasExt()
- @li HasName()
- @li HasVolume()
- @li SetExt()
- @li ClearExt()
- @li SetEmptyExt()
- @li SetName()
- @li SetVolume()
-
- You can initialize a wxFileName instance using one of the following functions:
-
- @li wxFileName()
- @li Assign()
- @li AssignCwd()
- @li AssignDir()
- @li AssignHomeDir()
- @li DirName()
- @li FileName()
-
- wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
- and VMS formats (Mac OS no longer being maintained as OS X uses the Unix notation).
- Although these formats are quite different, wxFileName tries to treat them all
- in the same generic way. It supposes that all file names consist of the following
- parts: the volume (also known as drive under Windows or device under VMS), the
- path which is a sequence of directory names separated by the
- @ref getpathseparators() "path separators"
- and the full filename itself which, in turn, is composed from the base file name
- and the extension. All of the individual components of the file name may be empty
- and, for example, the volume name is always empty under Unix, but if they are all
- empty simultaneously, the filename object is considered to be in an invalid
- state and IsOk() returns @false for it.
- File names can be case-sensitive or not, the function IsCaseSensitive() allows to
- determine this. The rules for determining whether the file name is absolute or
- relative also depend on the file name format and the only portable way to answer
- this question is to use IsAbsolute() or IsRelative() method. Note that on Windows,
- "X:" refers to the current working directory on drive X. Therefore, a wxFileName
- instance constructed from for example "X:dir/file.ext" treats the portion beyond
- drive separator as being relative to that directory. To ensure that the filename
- is absolute, you may use MakeAbsolute(). There is also an inverse function
- MakeRelativeTo() which undoes what Normalize(wxPATH_NORM_DOTS) does.
- Other functions returning information about the file format provided by this
- class are GetVolumeSeparator(), IsPathSeparator().
-
- Before doing other tests, you should use IsOk() to verify that the filename
- is well defined. If it is, FileExists() can be used to test whether a file
- with such name exists and DirExists() can be used to test for directory existence.
- File names should be compared using the SameAs() method or operator=(). For testing
- basic access modes, you can use:
-
- @li IsDirWritable()
- @li IsDirReadable()
- @li IsFileWritable()
- @li IsFileReadable()
- @li IsFileExecutable()
-
- These methods allow to work with the file creation, access and modification
- times. Note that not all filesystems under all platforms implement these times
- in the same way. For example, the access time under Windows has a resolution of
- one day (so it is really the access date and not time). The access time may be
- updated when the file is executed or not depending on the platform.
-
- @li GetModificationTime()
- @li GetTimes()
- @li SetTimes()
- @li Touch()
-
- Other file system operations functions are:
-
- @li Mkdir()
- @li Rmdir()
+ Please note that many wxFileName methods accept the path format argument
+ which is by @c wxPATH_NATIVE by default meaning to use the path format
+ native for the current platform.
+ The path format affects the operation of wxFileName functions in several ways:
+ first and foremost, it defines the path separator character to use, but it
+ also affects other things such as whether the path has the drive part or not.
+ See wxPathFormat for more info.
+
+
+ @section filename_format File name format
+
+ wxFileName currently supports the file names in the Unix, DOS/Windows,
+ Mac OS and VMS formats. Although these formats are quite different,
+ wxFileName tries to treat them all in the same generic way.
+ It supposes that all file names consist of the following parts: the volume
+ (also known as drive under Windows or device under VMS), the path which is
+ a sequence of directory names separated by the path separators and the full
+ filename itself which, in turn, is composed from the base file name and the
+ extension. All of the individual components of the file name may be empty
+ and, for example, the volume name is always empty under Unix, but if they
+ are all empty simultaneously, the filename object is considered to be in an
+ invalid state and wxFileName::IsOk() returns false for it.
+
+ File names can be case-sensitive or not, the function wxFileName::IsCaseSensitive()
+ allows to determine this. The rules for determining whether the file name is
+ absolute or relative also depend on the file name format and the only portable way
+ to answer this question is to use wxFileName::IsAbsolute() or wxFileName::IsRelative()
+ method.
+
+ Note that on Windows,"X:" refers to the current working directory on drive X.
+ Therefore, a wxFileName instance constructed from for example "X:dir/file.ext"
+ treats the portion beyond drive separator as being relative to that directory.
+ To ensure that the filename is absolute, you may use wxFileName::MakeAbsolute().
+ There is also an inverse function wxFileName::MakeRelativeTo() which undoes
+ what wxFileName::Normalize(wxPATH_NORM_DOTS) does.
+ Other functions returning information about the file format provided by this
+ class are wxFileName::GetVolumeSeparator(), wxFileName::IsPathSeparator().
+
+
+ @section filename_construction File name construction
+
+ You can initialize a wxFileName instance using one of the following functions:
+
+ @li wxFileName::wxFileName()
+ @li wxFileName::Assign()
+ @li wxFileName::AssignCwd()
+ @li wxFileName::AssignDir()
+ @li wxFileName::AssignHomeDir()
+ @li wxFileName::DirName()
+ @li wxFileName::FileName()
+ @li wxFileName::operator=()
+
+
+ @section filename_tests File name tests
+
+ Before doing other tests, you should use wxFileName::IsOk() to verify that
+ the filename is well defined. If it is, FileExists() can be used to test whether
+ a file with such name exists and wxFileName::DirExists() can be used to test
+ for directory existence.
+ File names should be compared using the wxFileName::SameAs() method or
+ wxFileName::operator==(). For testing basic access modes, you can use:
+
+ @li wxFileName::IsDirWritable()
+ @li wxFileName::IsDirReadable()
+ @li wxFileName::IsFileWritable()
+ @li wxFileName::IsFileReadable()
+ @li wxFileName::IsFileExecutable()
+
+
+ @section filename_components File name components
+
+ These functions allow to examine and modify the individual directories
+ of the path:
+
+ @li wxFileName::AppendDir()
+ @li wxFileName::InsertDir()
+ @li wxFileName::GetDirCount()
+ @li wxFileName::PrependDir()
+ @li wxFileName::RemoveDir()
+ @li wxFileName::RemoveLastDir()
+
+ To change the components of the file name individually you can use the
+ following functions:
+
+ @li wxFileName::GetExt()
+ @li wxFileName::GetName()
+ @li wxFileName::GetVolume()
+ @li wxFileName::HasExt()
+ @li wxFileName::HasName()
+ @li wxFileName::HasVolume()
+ @li wxFileName::SetExt()
+ @li wxFileName::ClearExt()
+ @li wxFileName::SetEmptyExt()
+ @li wxFileName::SetName()
+ @li wxFileName::SetVolume()
+
+ You can initialize a wxFileName instance using one of the following functions:
+
+
+ @section filename_operations File name operations
+
+ These methods allow to work with the file creation, access and modification
+ times. Note that not all filesystems under all platforms implement these times
+ in the same way. For example, the access time under Windows has a resolution of
+ one day (so it is really the access date and not time). The access time may be
+ updated when the file is executed or not depending on the platform.
+
+ @li wxFileName::GetModificationTime()
+ @li wxFileName::GetTimes()
+ @li wxFileName::SetTimes()
+ @li wxFileName::Touch()
+
+ Other file system operations functions are:
+
+ @li wxFileName::Mkdir()
+ @li wxFileName::Rmdir()
@library{wxbase}
@category{file}
-
- @see wxFileName::GetCwd
*/
class wxFileName
{
Default constructor.
*/
wxFileName();
+
/**
Copy constructor.
*/
wxFileName(const wxFileName& filename);
+
/**
- Constructor from a full file name including the path.
+ Constructor taking a full filename.
+
+ If it terminates with a '/', a directory path is constructed
+ (the name will be empty), otherwise a file name and extension
+ are extracted from it.
*/
wxFileName(const wxString& fullpath,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Constructor a directory name and file name.
*/
wxFileName(const wxString& path, const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Constructor from a directory name, base file name and extension.
*/
wxFileName(const wxString& path, const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Constructor from a volume name, a directory name, base file name and extension.
*/
Creates the file name from another filename object.
*/
void Assign(const wxFileName& filepath);
+
/**
Creates the file name from a full file name with a path.
*/
void Assign(const wxString& fullpath,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Creates the file name from volumne, path, name and extension.
*/
const wxString& ext,
bool hasExt,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Creates the file name from volumne, path, name and extension.
*/
const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Creates the file name from file path and file name.
*/
void Assign(const wxString& path, const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
+
/**
Creates the file name from path, name and extension.
*/
static void AssignCwd(const wxString& volume = wxEmptyString);
/**
- Sets this file name object to the given directory name. The name and extension
- will be empty.
+ Sets this file name object to the given directory name.
+ The name and extension will be empty.
*/
void AssignDir(const wxString& dir,
wxPathFormat format = wxPATH_NATIVE);
void AssignHomeDir();
/**
- The function calls CreateTempFileName() to
- create a temporary file and sets this object to the name of the file. If a
- temporary file couldn't be created, the object is put into the
- @ref isok() invalid state.
+ The function calls CreateTempFileName() to create a temporary file
+ and sets this object to the name of the file.
+ If a temporary file couldn't be created, the object is put into
+ an invalid state (see IsOk())
*/
void AssignTempFileName(const wxString& prefix,
wxFile* fileTemp = NULL);
void ClearExt();
/**
- Returns a temporary file name starting with the given @e prefix. If
- the @a prefix is an absolute path, the temporary file is created in this
+ Returns a temporary file name starting with the given @e prefix.
+ If the @a prefix is an absolute path, the temporary file is created in this
directory, otherwise it is created in the default system directory for the
temporary files or in the current directory.
- If the function succeeds, the temporary file is actually created. If
- @a fileTemp is not @NULL, this file will be opened using the name of
+
+ If the function succeeds, the temporary file is actually created.
+ If @a fileTemp is not @NULL, this file will be opened using the name of
the temporary file. When possible, this is done in an atomic way ensuring that
no race condition occurs between the temporary file name generation and opening
it which could often lead to security compromise on the multiuser systems.
/**
Returns @true if the directory with this name exists.
*/
- bool DirExists();
-
+ bool DirExists() const;
+
/**
Returns @true if the directory with this name exists.
*/
- const static bool DirExists(const wxString& dir);
+ static bool DirExists(const wxString& dir);
/**
Returns the object corresponding to the directory with the given name.
@see DirExists()
*/
- bool FileExists();
-
+ bool FileExists() const;
+
/**
Returns @true if the file with this name exists.
@see DirExists()
*/
- const static bool FileExists(const wxString& file);
+ static bool FileExists(const wxString& file);
/**
Returns the file name object corresponding to the given @e file. This
wxPathFormat format = wxPATH_NATIVE);
/**
- Retrieves the value of the current working directory on the specified volume. If
- the volume is empty, the program's current working directory is returned for the
- current volume.
+ Retrieves the value of the current working directory on the specified volume.
+ If the volume is empty, the program's current working directory is returned for
+ the current volume.
@return The string containing the current working directory or an empty
- string on error.
+ string on error.
@see AssignCwd()
*/
- static wxString GetCwd(const wxString& volume = "");
+ static wxString GetCwd(const wxString& volume = wxEmptyString);
/**
Returns the number of directories in the file name.
/**
Returns the directories in string array form.
*/
- const wxArrayString GetDirs() const;
+ const wxArrayString& GetDirs() const;
/**
Returns the file name extension.
wxString GetExt() const;
/**
- Returns the characters that can't be used in filenames and directory names for
- the specified format.
+ Returns the characters that can't be used in filenames and directory names
+ for the specified format.
*/
static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
/**
Returns the size of the file in a human-readable form.
+
If the size could not be retrieved the @c failmsg string
is returned. In case of success, the returned string is
a floating-point number with @c precision decimal digits
bytes, kilobytes, megabytes, gigabytes, terabytes).
*/
wxString GetHumanReadableSize(const wxString& failmsg = "Not available",
- int precision = 1);
-
+ int precision = 1) const;
+
/**
Returns the size of the given number of bytes in a human-readable form.
- If @c bytes is @c wxInvalidSize or zero, then @c nullsize is returned.
- In case of success, the returned string is a floating-point number with @c
- precision decimal digits followed by the size unit (B, kB, MB, GB,
+
+ If @a bytes is ::wxInvalidSize or zero, then @a nullsize is returned.
+
+ In case of success, the returned string is a floating-point number with
+ @a precision decimal digits followed by the size unit (B, kB, MB, GB,
TB: respectively bytes, kilobytes, megabytes, gigabytes, terabytes).
*/
- const static wxString GetHumanReadableSize(const wxULongLong& bytes,
- const wxString& nullsize = "Not available",
- int precision = 1);
+ static wxString GetHumanReadableSize(const wxULongLong& bytes,
+ const wxString& nullsize = "Not available",
+ int precision = 1);
/**
- Return the long form of the path (returns identity on non-Windows platforms)
+ Return the long form of the path (returns identity on non-Windows platforms).
*/
wxString GetLongPath() const;
The possible flags values are:
- @b wxPATH_GET_VOLUME
-
+ - @b wxPATH_GET_VOLUME
Return the path with the volume (does nothing for the filename formats
without volumes), otherwise the path without volume part is returned.
- @b wxPATH_GET_SEPARATOR
-
+ - @b wxPATH_GET_SEPARATOR:
Return the path with the trailing separator, if this flag is not given
there will be no separator at the end of the path.
- @b wxPATH_NO_SEPARATOR
-
+ - @b wxPATH_NO_SEPARATOR:
Don't include the trailing separator in the returned string. This is
the default (the value of this flag is 0) and exists only for symmetry
with wxPATH_GET_SEPARATOR.
wxPathFormat format = wxPATH_NATIVE) const;
/**
- Returns the usually used path separator for this format. For all formats but
- @c wxPATH_DOS there is only one path separator anyhow, but for DOS there
- are two of them and the native one, i.e. the backslash is returned by this
- method.
+ Returns the usually used path separator for this format.
+ For all formats but @c wxPATH_DOS there is only one path separator anyhow,
+ but for DOS there are two of them and the native one, i.e. the backslash
+ is returned by this method.
@see GetPathSeparators()
*/
static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE);
/**
- Returns the string containing all the path separators for this format. For all
- formats but @c wxPATH_DOS this string contains only one character but for
- DOS and Windows both @c '/' and @c '\' may be used as
- separators.
+ Returns the string containing all the path separators for this format.
+ For all formats but @c wxPATH_DOS this string contains only one character
+ but for DOS and Windows both @c '/' and @c '\' may be used as separators.
@see GetPathSeparator()
*/
static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
/**
- Returns the string of characters which may terminate the path part. This is the
- same as GetPathSeparators() except for VMS
+ Returns the string of characters which may terminate the path part.
+ This is the same as GetPathSeparators() except for VMS
path format where ] is used at the end of the path part.
*/
static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
/**
- Returns the path with the trailing separator, useful for appending the name to
- the given path.
- This is the same as calling GetPath()
- @c (wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format).
+ Returns the path with the trailing separator, useful for appending the name
+ to the given path.
+
+ This is the same as calling
+ @code
+ GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format)
+ @endcode
*/
wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE) const;
/**
Returns the size of the file If the file does not exist or its size could
not be read (because e.g. the file is locked by another process) the returned
- value is @c wxInvalidSize.
+ value is ::wxInvalidSize.
*/
wxULongLong GetSize();
+
/**
Returns the size of the file If the file does not exist or its size could
not be read (because e.g. the file is locked by another process) the returned
- value is @c wxInvalidSize.
+ value is ::wxInvalidSize.
*/
const static wxULongLong GetSize(const wxString& filename);
static wxString GetTempDir();
/**
- Returns the last access, last modification and creation times. The last access
- time is updated whenever the file is read or written (or executed in the case
- of Windows), last modification time is only changed when the file is written
- to. Finally, the creation time is indeed the time when the file was created
+ Returns the last access, last modification and creation times.
+ The last access time is updated whenever the file is read or written
+ (or executed in the case of Windows), last modification time is only
+ changed when the file is written to.
+ Finally, the creation time is indeed the time when the file was created
under Windows and the inode change time under Unix (as it is impossible to
retrieve the real file creation time there anyhow) which can also be changed
by many operations after the file creation.
+
If no filename or extension is specified in this instance of wxFileName
- (and therefore IsDir() returns @true) then
- this function will return the directory times of the path specified by
- GetPath(), otherwise the file times of the
- file specified by GetFullPath().
- Any of the pointers may be @NULL if the corresponding time is not
- needed.
+ (and therefore IsDir() returns @true) then this function will return the
+ directory times of the path specified by GetPath(), otherwise the file
+ times of the file specified by GetFullPath().
+ Any of the pointers may be @NULL if the corresponding time is not needed.
@return @true on success, @false if we failed to retrieve the times.
*/
/**
Returns the string containing the volume for this file name, empty if it
- doesn't have one or if the file system doesn't support volumes at all (for
- example, Unix).
+ doesn't have one or if the file system doesn't support volumes at all
+ (for example, Unix).
*/
wxString GetVolume() const;
@since 2.9.0
@param drive
- The drive letter, 'A' through 'Z' or 'a' through 'z'.
+ The drive letter, 'A' through 'Z' or 'a' through 'z'.
@param flags
- @c wxPATH_NO_SEPARATOR or @c wxPATH_GET_SEPARATOR to omit or include
- the trailing path separator, the default is to include it.
+ @c wxPATH_NO_SEPARATOR or @c wxPATH_GET_SEPARATOR to omit or include
+ the trailing path separator, the default is to include it.
@return Volume path string.
*/
/**
Returns @true if this object represents a directory, @false otherwise
- (i.e. if it is a file). Note that this method doesn't test whether the
- directory or file really exists, you should use
- DirExists() or
- FileExists() for this.
+ (i.e. if it is a file).
+
+ Note that this method doesn't test whether the directory or file really
+ exists, you should use DirExists() or FileExists() for this.
*/
bool IsDir() const;
doesn't imply that you have read permissions on the files contained.
*/
bool IsDirReadable() const;
-
+
/**
Returns @true if the given @e dir is an existing directory and this process
has read permissions on it. Read permissions on a directory mean that you
directory.
*/
bool IsDirWritable() const;
+
/**
- Returns @true if the given @e dir
- is an existing directory and this process has write permissions on it.
+ Returns @true if the given @a dir is an existing directory and this
+ process has write permissions on it.
Write permissions on a directory mean that you can create new files in the
directory.
*/
permissions on it.
*/
bool IsFileExecutable() const;
-
+
/**
Returns @true if a file with this name exists and if this process has execute
permissions on it.
permissions on it.
*/
bool IsFileReadable() const;
-
+
/**
Returns @true if a file with this name exists and if this process has read
permissions on it.
permissions on it.
*/
bool IsFileWritable() const;
+
/**
Returns @true if a file with this name exists and if this process has write
permissions on it.
static bool IsFileWritable(const wxString& file);
/**
- Returns @true if the filename is valid, @false if it is not
- initialized yet. The assignment functions and
- Clear() may reset the object to the uninitialized,
+ Returns @true if the filename is valid, @false if it is not initialized yet.
+ The assignment functions and Clear() may reset the object to the uninitialized,
invalid state (the former only do it on failure).
*/
bool IsOk() const;
On Mac OS, gets the common type and creator for the given extension.
*/
static bool MacFindDefaultTypeAndCreator(const wxString& ext,
- wxUint32* type,
- wxUint32* creator);
+ wxUint32* type,
+ wxUint32* creator);
/**
- On Mac OS, registers application defined extensions and their default type and
- creator.
+ On Mac OS, registers application defined extensions and their default type
+ and creator.
*/
static void MacRegisterDefaultTypeAndCreator(const wxString& ext,
- wxUint32 type,
- wxUint32 creator);
+ wxUint32 type,
+ wxUint32 creator);
/**
- On Mac OS, looks up the appropriate type and creator from the registration and
- then sets it.
+ On Mac OS, looks up the appropriate type and creator from the registration
+ and then sets it.
*/
bool MacSetDefaultTypeAndCreator();
/**
- Make the file name absolute. This is a shortcut for
- @c wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
- wxPATH_NORM_TILDE, cwd, format).
+ Make the file name absolute.
+ This is a shortcut for
+ @code
+ wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
+ wxPATH_NORM_TILDE, cwd, format)
+ @endcode
@see MakeRelativeTo(), Normalize(), IsAbsolute()
*/
/**
This function tries to put this file name in a form relative to
+ @a pathBase.
+ In other words, it returns the file name which should be used to access
+ this file if the current directory were pathBase.
@param pathBase.
- In other words, it returns the file name which should be used to access this
- file if the current directory were pathBase.
-
- pathBase
- the directory to use as root, current directory is used by
- default
+ The directory to use as root, current directory is used by default
@param format
- the file name format, native by default
+ The file name format, native by default
@return @true if the file name has been changed, @false if we failed to do
- anything with it (currently this only happens if the
- file name is on a volume different from the volume
- specified by pathBase).
+ anything with it (currently this only happens if the file name
+ is on a volume different from the volume specified by @a pathBase).
@see Normalize()
*/
/**
Creates a directory.
-
- @param parm
- the permissions for the newly created directory
+
+ @param perm
+ The permissions for the newly created directory
@param flags
- if the flags contain wxPATH_MKDIR_FULL flag,
- try to create each directory in the path and also don't return an error
- if the target directory already exists.
+ If the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
+ directory in the path and also don't return an error if the target
+ directory already exists.
@return Returns @true if the directory was successfully created, @false
- otherwise.
+ otherwise.
*/
bool Mkdir(int perm = 0777, int flags = 0);
+
/**
Creates a directory.
-
+
@param dir
the directory to create
@param parm
the permissions for the newly created directory
@param flags
- if the flags contain wxPATH_MKDIR_FULL flag,
- try to create each directory in the path and also don't return an error
- if the target directory already exists.
+ if the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
+ directory in the path and also don't return an error if the target
+ directory already exists.
@return Returns @true if the directory was successfully created, @false
- otherwise.
+ otherwise.
*/
static bool Mkdir(const wxString& dir, int perm = 0777,
int flags = 0);
@param flags
The kind of normalization to do with the file name. It can be
- any or-combination of the following constants:
-
- - wxPATH_NORM_ENV_VARS: replace env vars with their values
- - wxPATH_NORM_DOTS: squeeze all .. and . when possible; if
- there are too many .. and thus they cannot be all removed,
- @false will be returned
- - wxPATH_NORM_CASE: if filesystem is case insensitive, transform
- to lower case
- - wxPATH_NORM_ABSOLUTE: make the path absolute prepending cwd
- - wxPATH_NORM_LONG: make the path the long form
- - wxPATH_NORM_SHORTCUT: resolve if it is a shortcut (Windows only)
- - wxPATH_NORM_TILDE: replace ~ and ~user (Unix only)
- - wxPATH_NORM_ALL: all of previous flags except wxPATH_NORM_CASE
-
+ any or-combination of the wxPathNormalize enumeration values.
@param cwd
If not empty, this directory will be used instead of current
- working directory in normalization (see wxPATH_NORM_ABSOLUTE).
+ working directory in normalization (see @c wxPATH_NORM_ABSOLUTE).
@param format
The file name format to use when processing the paths, native by default.
const wxString& cwd = wxEmptyString,
wxPathFormat format = wxPATH_NATIVE);
-
/**
- Prepends a directory to the file path. Please see
- AppendDir() for important notes.
+ Prepends a directory to the file path.
+ Please see AppendDir() for important notes.
*/
void PrependDir(const wxString& dir);
Deletes the specified directory from the file system.
*/
bool Rmdir();
+
/**
Deletes the specified directory from the file system.
*/
Changes the current working directory.
*/
bool SetCwd();
+
/**
Changes the current working directory.
*/
void SetEmptyExt();
/**
- Sets the extension of the file name. Setting an empty string
- as the extension will remove the extension resulting in a file
- name without a trailing dot, unlike a call to
+ Sets the extension of the file name.
+
+ Setting an empty string as the extension will remove the extension
+ resulting in a file name without a trailing dot, unlike a call to
SetEmptyExt().
@see SetEmptyExt(), ClearExt()
/**
This function splits a full file name into components: the volume (with the
first version) path (including the volume in the second version), the base name
- and the extension. Any of the output parameters (@e volume, @e path,
- @a name or @e ext) may be @NULL if you are not interested in the
- value of a particular component. Also, @a fullpath may be empty on entry.
+ and the extension.
+
+ Any of the output parameters (@e volume, @e path, @a name or @e ext) may
+ be @NULL if you are not interested in the value of a particular component.
+ Also, @a fullpath may be empty on entry.
On return, @a path contains the file path (without the trailing separator),
@a name contains the file name and @a ext contains the file extension
without leading dot. All three of them may be empty if the corresponding
component is. The old contents of the strings pointed to by these parameters
will be overwritten in any case (if the pointers are not @NULL).
+
Note that for a filename "foo." the extension is present, as indicated by the
trailing dot, but empty. If you need to cope with such cases, you should use
@a hasExt instead of relying on testing whether @a ext is empty or not.
Returns @true if the filenames are different. The string @e filenames
is interpreted as a path in the native filename format.
*/
- bool operator operator!=(const wxFileName& filename) const;
+ bool operator!=(const wxFileName& filename) const;
+
/**
Returns @true if the filenames are different. The string @e filenames
is interpreted as a path in the native filename format.
*/
- bool operator operator!=(const wxString& filename) const;
+ bool operator!=(const wxString& filename) const;
/**
- Assigns the new value to this filename object.
- */
- wxFileName& operator operator=(const wxFileName& filename);
- /**
- Assigns the new value to this filename object.
+ Returns @true if the filenames are equal. The string @e filenames is
+ interpreted as a path in the native filename format.
*/
- wxFileName& operator operator=(const wxString& filename);
+ bool operator==(const wxFileName& filename) const;
/**
Returns @true if the filenames are equal. The string @e filenames is
interpreted as a path in the native filename format.
*/
- bool operator operator==(const wxFileName& filename) const;
+ bool operator==(const wxString& filename) const;
+
/**
- Returns @true if the filenames are equal. The string @e filenames is
- interpreted as a path in the native filename format.
+ Assigns the new value to this filename object.
+ */
+ wxFileName& operator=(const wxFileName& filename);
+
+ /**
+ Assigns the new value to this filename object.
*/
- bool operator operator==(const wxString& filename) const;
+ wxFileName& operator=(const wxString& filename);
};
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.
+ file-chooser dialog.
It is only available if @c wxUSE_FILEPICKERCTRL is set to 1 (the default).
@beginStyleTable
Change current working directory on each user file selection change.
@endStyleTable
+
+ @beginEventTable{wxFileDirPickerEvent}
+ @event{EVT_FILEPICKER_CHANGED(id, func)}
+ The user changed the file selected in the control either using the
+ button or using text control (see wxFLP_USE_TEXTCTRL; note that in
+ this case the event is fired only if the user's input is valid,
+ e.g. an existing file path if wxFLP_FILE_MUST_EXIST was given).
+ @endEventTable
+
@library{wxcore}
@category{pickers}
<!-- @appearance{filepickerctrl.png} -->
const wxString& name = "filepickerctrl");
/**
+ Creates this widget with the given parameters.
+
@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.
+ 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).
+ wxFileDialog's wildcards).
@param pos
Initial position.
@param size
Control name.
@return @true if the control was successfully created or @false if
- creation failed.
+ creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& name = "filepickerctrl");
/**
- Similar to GetPath() but returns the path of
- the currently selected file as a wxFileName object.
+ Similar to GetPath() but returns the path of the currently selected
+ file as a wxFileName object.
*/
wxFileName GetFileName() const;
wxString GetPath() const;
/**
- This method does the same thing as SetPath() but
- takes a wxFileName object instead of a string.
+ This method does the same thing as SetPath() but takes a wxFileName
+ object instead of a string.
*/
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.
+ 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);
};
@class wxDirPickerCtrl
This control allows the user to select a directory. The generic implementation
- is
- a button which brings up a wxDirDialog when clicked. Native implementation
+ is a button which brings up a wxDirDialog when clicked. Native implementation
may differ but this is usually a (small) widget which give access to the
- dir-chooser
- dialog.
+ dir-chooser dialog.
It is only available if @c wxUSE_DIRPICKERCTRL is set to 1 (the default).
@beginStyleTable
wxGTK control always adds this flag internally as it does not
support its absence.
@style{wxDIRP_CHANGE_DIR}
- Change current working directory on each user directory selection
- change.
+ Change current working directory on each user directory selection change.
@endStyleTable
+ @beginEventTable{wxFileDirPickerEvent}
+ @event{EVT_DIRPICKER_CHANGED(id, func)}
+ The user changed the directory selected in the control either using the
+ button or using text control (see wxDIRP_USE_TEXTCTRL; note that in this
+ case the event is fired only if the user's input is valid, e.g. an
+ existing directory path).
+ @endEventTable
+
+
@library{wxcore}
@category{pickers}
<!-- @appearance{dirpickerctrl.png} -->
const wxString& name = "dirpickerctrl");
/**
+ Creates the widgets with the given parameters.
+
@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.
+ directory or the empty string.
@param message
The message shown to the user in the wxDirDialog shown by the control.
@param pos
Control name.
@return @true if the control was successfully created or @false if
- creation failed.
+ creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString,
const wxString& name = "dirpickerctrl");
/**
- Returns the absolute path of the currently selected directory as a wxFileName
- object.
- This function is equivalent to GetPath()
+ Returns the absolute path of the currently selected directory as a
+ wxFileName object.
+ This function is equivalent to GetPath().
*/
wxFileName GetDirName() const;
wxString GetPath() const;
/**
- Just like SetPath() but this function takes a
- wxFileName object.
+ Just like SetPath() but this function takes a wxFileName object.
*/
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.
+ 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);
};
wxFilePickerCtrl and by wxDirPickerCtrl.
@library{wxcore}
- @category{FIXME}
+ @category{events}
- @see wxfilepickerctrl()
+ @see wxFilePickerCtrl, wxDirPickerCtrl
*/
class wxFileDirPickerEvent : public wxCommandEvent
{
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+
+/**
+ Standard font families: these may be used only for the font creation, it
+ doesn't make sense to query an existing font for its font family as,
+ especially if the font had been created from a native font description, it
+ may be unknown.
+*/
+enum wxFontFamily
+{
+ wxFONTFAMILY_DEFAULT = wxDEFAULT, //!< Chooses a default font.
+ wxFONTFAMILY_DECORATIVE = wxDECORATIVE, //!< A decorative font.
+ wxFONTFAMILY_ROMAN = wxROMAN, //!< A formal, serif font.
+ wxFONTFAMILY_SCRIPT = wxSCRIPT, //!< A handwriting font.
+ wxFONTFAMILY_SWISS = wxSWISS, //!< A sans-serif font.
+ wxFONTFAMILY_MODERN = wxMODERN, //!< A fixed pitch font.
+ wxFONTFAMILY_TELETYPE = wxTELETYPE, //!< A teletype font.
+ wxFONTFAMILY_MAX,
+ wxFONTFAMILY_UNKNOWN = wxFONTFAMILY_MAX
+};
+
+/**
+ Font styles.
+*/
+enum wxFontStyle
+{
+ wxFONTSTYLE_NORMAL = wxNORMAL,
+ wxFONTSTYLE_ITALIC = wxITALIC,
+ wxFONTSTYLE_SLANT = wxSLANT,
+ wxFONTSTYLE_MAX
+};
+
+/**
+ Font weights.
+*/
+enum wxFontWeight
+{
+ wxFONTWEIGHT_NORMAL = wxNORMAL, //!< Normal font.
+ wxFONTWEIGHT_LIGHT = wxLIGHT, //!< Light font.
+ wxFONTWEIGHT_BOLD = wxBOLD, //!< Bold font.
+ wxFONTWEIGHT_MAX
+};
+
+/**
+ The font flag bits for the new font ctor accepting one combined flags word.
+*/
+enum wxFontFlag
+{
+ /// no special flags: font with default weight/slant/anti-aliasing
+ wxFONTFLAG_DEFAULT = 0,
+
+ /// slant flags (default: no slant)
+ wxFONTFLAG_ITALIC = 1 << 0,
+ wxFONTFLAG_SLANT = 1 << 1,
+
+ /// weight flags (default: medium)
+ wxFONTFLAG_LIGHT = 1 << 2,
+ wxFONTFLAG_BOLD = 1 << 3,
+
+ /// anti-aliasing flag: force on or off (default: the current system default)
+ wxFONTFLAG_ANTIALIASED = 1 << 4,
+ wxFONTFLAG_NOT_ANTIALIASED = 1 << 5,
+
+ /// underlined/strikethrough flags (default: no lines)
+ wxFONTFLAG_UNDERLINED = 1 << 6,
+ wxFONTFLAG_STRIKETHROUGH = 1 << 7,
+
+ /// the mask of all currently used flags
+ wxFONTFLAG_MASK = wxFONTFLAG_ITALIC |
+ wxFONTFLAG_SLANT |
+ wxFONTFLAG_LIGHT |
+ wxFONTFLAG_BOLD |
+ wxFONTFLAG_ANTIALIASED |
+ wxFONTFLAG_NOT_ANTIALIASED |
+ wxFONTFLAG_UNDERLINED |
+ wxFONTFLAG_STRIKETHROUGH
+};
+
+
+
+/**
+ Font encodings.
+*/
+enum wxFontEncoding
+{
+ /// Default system encoding.
+ wxFONTENCODING_SYSTEM = -1, // system default
+
+ /// Default application encoding.
+ wxFONTENCODING_DEFAULT, // current default encoding
+
+ // ISO8859 standard defines a number of single-byte charsets
+ wxFONTENCODING_ISO8859_1, // West European (Latin1)
+ wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
+ wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
+ wxFONTENCODING_ISO8859_4, // Baltic (old) (Latin4)
+ wxFONTENCODING_ISO8859_5, // Cyrillic
+ wxFONTENCODING_ISO8859_6, // Arabic
+ wxFONTENCODING_ISO8859_7, // Greek
+ wxFONTENCODING_ISO8859_8, // Hebrew
+ wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
+ wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
+ wxFONTENCODING_ISO8859_11, // Thai
+ wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
+ // here anyhow to make all ISO8859
+ // consecutive numbers
+ wxFONTENCODING_ISO8859_13, // Baltic (Latin7)
+ wxFONTENCODING_ISO8859_14, // Latin8
+ wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
+ wxFONTENCODING_ISO8859_MAX,
+
+ // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
+ wxFONTENCODING_KOI8, // KOI8 Russian
+ wxFONTENCODING_KOI8_U, // KOI8 Ukrainian
+ wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
+ wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
+
+ // what would we do without Microsoft? They have their own encodings
+ // for DOS
+ wxFONTENCODING_CP437, // original MS-DOS codepage
+ wxFONTENCODING_CP850, // CP437 merged with Latin1
+ wxFONTENCODING_CP852, // CP437 merged with Latin2
+ wxFONTENCODING_CP855, // another cyrillic encoding
+ wxFONTENCODING_CP866, // and another one
+ // and for Windows
+ wxFONTENCODING_CP874, // WinThai
+ wxFONTENCODING_CP932, // Japanese (shift-JIS)
+ wxFONTENCODING_CP936, // Chinese simplified (GB)
+ wxFONTENCODING_CP949, // Korean (Hangul charset)
+ wxFONTENCODING_CP950, // Chinese (traditional - Big5)
+ wxFONTENCODING_CP1250, // WinLatin2
+ wxFONTENCODING_CP1251, // WinCyrillic
+ wxFONTENCODING_CP1252, // WinLatin1
+ wxFONTENCODING_CP1253, // WinGreek (8859-7)
+ wxFONTENCODING_CP1254, // WinTurkish
+ wxFONTENCODING_CP1255, // WinHebrew
+ wxFONTENCODING_CP1256, // WinArabic
+ wxFONTENCODING_CP1257, // WinBaltic (same as Latin 7)
+ wxFONTENCODING_CP12_MAX,
+
+ wxFONTENCODING_UTF7, // UTF-7 Unicode encoding
+ wxFONTENCODING_UTF8, // UTF-8 Unicode encoding
+ wxFONTENCODING_EUC_JP, // Extended Unix Codepage for Japanese
+ wxFONTENCODING_UTF16BE, // UTF-16 Big Endian Unicode encoding
+ wxFONTENCODING_UTF16LE, // UTF-16 Little Endian Unicode encoding
+ wxFONTENCODING_UTF32BE, // UTF-32 Big Endian Unicode encoding
+ wxFONTENCODING_UTF32LE, // UTF-32 Little Endian Unicode encoding
+
+ wxFONTENCODING_MACROMAN, // the standard mac encodings
+ wxFONTENCODING_MACJAPANESE,
+ wxFONTENCODING_MACCHINESETRAD,
+ wxFONTENCODING_MACKOREAN,
+ wxFONTENCODING_MACARABIC,
+ wxFONTENCODING_MACHEBREW,
+ wxFONTENCODING_MACGREEK,
+ wxFONTENCODING_MACCYRILLIC,
+ wxFONTENCODING_MACDEVANAGARI,
+ wxFONTENCODING_MACGURMUKHI,
+ wxFONTENCODING_MACGUJARATI,
+ wxFONTENCODING_MACORIYA,
+ wxFONTENCODING_MACBENGALI,
+ wxFONTENCODING_MACTAMIL,
+ wxFONTENCODING_MACTELUGU,
+ wxFONTENCODING_MACKANNADA,
+ wxFONTENCODING_MACMALAJALAM,
+ wxFONTENCODING_MACSINHALESE,
+ wxFONTENCODING_MACBURMESE,
+ wxFONTENCODING_MACKHMER,
+ wxFONTENCODING_MACTHAI,
+ wxFONTENCODING_MACLAOTIAN,
+ wxFONTENCODING_MACGEORGIAN,
+ wxFONTENCODING_MACARMENIAN,
+ wxFONTENCODING_MACCHINESESIMP,
+ wxFONTENCODING_MACTIBETAN,
+ wxFONTENCODING_MACMONGOLIAN,
+ wxFONTENCODING_MACETHIOPIC,
+ wxFONTENCODING_MACCENTRALEUR,
+ wxFONTENCODING_MACVIATNAMESE,
+ wxFONTENCODING_MACARABICEXT,
+ wxFONTENCODING_MACSYMBOL,
+ wxFONTENCODING_MACDINGBATS,
+ wxFONTENCODING_MACTURKISH,
+ wxFONTENCODING_MACCROATIAN,
+ wxFONTENCODING_MACICELANDIC,
+ wxFONTENCODING_MACROMANIAN,
+ wxFONTENCODING_MACCELTIC,
+ wxFONTENCODING_MACGAELIC,
+ wxFONTENCODING_MACKEYBOARD,
+
+ // more CJK encodings (for historical reasons some are already declared
+ // above)
+ wxFONTENCODING_ISO2022_JP, // ISO-2022-JP JIS encoding
+
+ wxFONTENCODING_MAX, // highest enumerated encoding value
+
+ wxFONTENCODING_MACMIN = wxFONTENCODING_MACROMAN ,
+ wxFONTENCODING_MACMAX = wxFONTENCODING_MACKEYBOARD ,
+
+ // aliases for endian-dependent UTF encodings
+#ifdef WORDS_BIGENDIAN
+ wxFONTENCODING_UTF16 = wxFONTENCODING_UTF16BE, // native UTF-16
+ wxFONTENCODING_UTF32 = wxFONTENCODING_UTF32BE, // native UTF-32
+#else // WORDS_BIGENDIAN
+ wxFONTENCODING_UTF16 = wxFONTENCODING_UTF16LE, // native UTF-16
+ wxFONTENCODING_UTF32 = wxFONTENCODING_UTF32LE, // native UTF-32
+#endif // WORDS_BIGENDIAN
+
+ // alias for the native Unicode encoding on this platform
+ // (this is used by wxEncodingConverter and wxUTFFile only for now)
+#if SIZEOF_WCHAR_T == 2
+ wxFONTENCODING_UNICODE = wxFONTENCODING_UTF16,
+#else // SIZEOF_WCHAR_T == 4
+ wxFONTENCODING_UNICODE = wxFONTENCODING_UTF32,
+#endif
+
+ // alternative names for Far Eastern encodings
+ // Chinese
+ wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, // Simplified Chinese
+ wxFONTENCODING_BIG5 = wxFONTENCODING_CP950, // Traditional Chinese
+
+ // Japanese (see http://zsigri.tripod.com/fontboard/cjk/jis.html)
+ wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932 // Shift JIS
+};
+
+
+
/**
@class wxFont
- A font is an object which determines the appearance of text. Fonts are
- used for drawing text to a device context, and setting the appearance of
- a window's text.
+ A font is an object which determines the appearance of text.
+ Fonts are used for drawing text to a device context, and setting the appearance
+ of a window's text.
- This class uses @ref overview_trefcount "reference counting and copy-on-write"
+ This class uses @ref overview_refcount "reference counting and copy-on-write"
internally so that assignments between two instances of this class are very
cheap. You can therefore use actual objects instead of pointers without
efficiency problems. If an instance of this class is changed it will create
You can retrieve the current system font settings with wxSystemSettings.
- wxSystemSettings
-
@library{wxcore}
@category{gdi}
@stdobjects
::wxNullFont, ::wxNORMAL_FONT, ::wxSMALL_FONT, ::wxITALIC_FONT, ::wxSWISS_FONT
- @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
- wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
+ @see @ref overview_font, wxDC::SetFont, wxDC::DrawText,
+ wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
*/
class wxFont : public wxGDIObject
{
public:
//@{
/**
- Creates a font object.
+ Default ctor.
*/
wxFont();
/**
- Creates a font object with the specified font.
-
- @param font
- font object.
+ Copy constructor, uses @ref overview_refcount "reference counting".
*/
wxFont(const wxFont& font);
Size in points.
@param family
Font family, a generic way of referring to fonts without specifying actual
- facename. One of:
- <TABLE>
- <TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
- <TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
- <TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
- <TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
- </TABLE>
+ facename. One of the ::wxFontFamily enumeration values.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@param weight
- Font weight, sometimes also referred to as font boldness. One of:
- <TABLE>
- <TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
- </TABLE>
+ Font weight, sometimes also referred to as font boldness. One of
+ the ::wxFontWeight enumeration values.
@param underline
- The value can be @true or @false. At present this has an effect on Windows
- and Motif 2.x only.
+ The value can be @true or @false.
+ At present this has an effect on Windows and Motif 2.x only.
@param faceName
- An optional string specifying the actual typeface to be used. If it is an
- empty string,
- a default typeface will be chosen based on the family.
+ An optional string specifying the actual typeface to be used.
+ If it is an empty string, a default typeface will be chosen based on the family.
@param encoding
- An encoding which may be one of
- <TABLE>
- <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
- <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
- Default application encoding: this
- is the encoding set by calls to
- SetDefaultEncoding and which may be set to,
- say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
- default application encoding is the same as default system encoding.</TD></TR>
- <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
- <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
- <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
- </TABLE>
-
+ An encoding which may be one of the enumeration values of ::wxFontEncoding.
+ Briefly these can be summed up as:
+ <TABLE>
+ <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
+ <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
+ Default application encoding: this
+ is the encoding set by calls to
+ SetDefaultEncoding and which may be set to,
+ say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
+ default application encoding is the same as default system encoding.</TD></TR>
+ <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
+ <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
+ <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
+ </TABLE>
If the specified encoding isn't available, no font is created
(see also font encoding overview).
@remarks If the desired font does not exist, the closest match will be
- chosen. Under Windows, only scalable TrueType fonts are
- used.
+ chosen. Under Windows, only scalable TrueType fonts are used.
*/
wxFont(int pointSize, wxFontFamily family, int style,
wxFontWeight weight,
const bool underline = false,
const wxString& faceName = "",
wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+
/**
Creates a font object with the specified attributes.
@param pixelSize
- Size in pixels: this is directly supported only under MSW
- currently where this constructor can be used directly, under other
- platforms a
- font with the closest size to the given one is found using binary search and
- the static New method must be used.
+ Size in pixels: this is directly supported only under MSW currently
+ where this constructor can be used directly, under other platforms a
+ font with the closest size to the given one is found using binary search
+ and the static New method must be used.
@param family
Font family, a generic way of referring to fonts without specifying actual
- facename. One of:
- <TABLE>
- <TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
- <TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
- <TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
- <TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
- </TABLE>
+ facename. One of ::wxFontFamily enumeration values.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@param weight
- Font weight, sometimes also referred to as font boldness. One of:
- <TABLE>
- <TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
- </TABLE>
+ Font weight, sometimes also referred to as font boldness.
+ One of the ::wxFontWeight enumeration values.
@param underline
- The value can be @true or @false. At present this has an effect on Windows
- and Motif 2.x only.
+ The value can be @true or @false.
+ At present this has an effect on Windows and Motif 2.x only.
@param faceName
- An optional string specifying the actual typeface to be used. If it is an
- empty string,
- a default typeface will be chosen based on the family.
+ An optional string specifying the actual typeface to be used.
+ If it is an empty string, a default typeface will be chosen based on the family.
@param encoding
- An encoding which may be one of
- <TABLE>
- <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
- <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
- Default application encoding: this
- is the encoding set by calls to
- SetDefaultEncoding and which may be set to,
- say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
- default application encoding is the same as default system encoding.</TD></TR>
- <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
- <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
- <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
- </TABLE>
-
+ An encoding which may be one of the enumeration values of ::wxFontEncoding.
+ Briefly these can be summed up as:
+ <TABLE>
+ <TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
+ <TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
+ Default application encoding: this
+ is the encoding set by calls to
+ SetDefaultEncoding and which may be set to,
+ say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
+ default application encoding is the same as default system encoding.</TD></TR>
+ <TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
+ <TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
+ <TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
+ </TABLE>
If the specified encoding isn't available, no font is created
(see also font encoding overview).
@remarks If the desired font does not exist, the closest match will be
- chosen. Under Windows, only scalable TrueType fonts are
- used.
+ chosen. Under Windows, only scalable TrueType fonts are used.
*/
wxFont(const wxSize& pixelSize, wxFontFamily family,
int style, wxFontWeight weight,
/**
Destructor.
- See @ref overview_refcountdestruct "reference-counted object destruction" for
- more info.
+
+ See @ref overview_refcountdestruct "reference-counted object destruction"
+ for more info.
@remarks Although all remaining fonts are deleted when the application
exits, the application should try to clean up all fonts
/**
Returns the current application's default encoding.
- @see @ref overview_wxfontencodingoverview, SetDefaultEncoding()
+ @see @ref overview_fontencoding, SetDefaultEncoding()
*/
static wxFontEncoding GetDefaultEncoding();
/**
Returns the typeface name associated with the font, or the empty string if
- there is no
- typeface information.
+ there is no typeface information.
@see SetFaceName()
*/
/**
Returns the platform-dependent string completely describing this font.
Returned string is always non-empty.
+
Note that the returned string is not meant to be shown or edited by the user: a
- typical
- use of this function is for serializing in string-form a wxFont object.
+ typical use of this function is for serializing in string-form a wxFont object.
@see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
*/
wxString GetNativeFontInfoDesc() const;
/**
- Returns a user-friendly string for this font object. Returned string is always
- non-empty.
+ Returns a user-friendly string for this font object.
+ Returned string is always non-empty.
+
Some examples of the formats of returned strings (which are platform-dependent)
are in SetNativeFontInfoUserDesc().
int GetPointSize() const;
/**
- Gets the font style. See wxFont() for a list of valid
- styles.
+ Gets the font style. See wxFontStyle for a list of valid styles.
@see SetStyle()
*/
- int GetStyle() const;
+ wxFontStyle GetStyle() const;
/**
Returns @true if the font is underlined, @false otherwise.
bool GetUnderlined() const;
/**
- Gets the font weight. See wxFont() for a list of valid
- weight identifiers.
+ Gets the font weight. See wxFontWeight for a list of valid weight identifiers.
@see SetWeight()
*/
/**
These functions take the same parameters as @ref ctor() wxFont
constructor and return a new font object allocated on the heap.
+
Using @c New() is currently the only way to directly create a font with
the given size in pixels on platforms other than wxMSW.
*/
/**
Sets the default font encoding.
- @see @ref overview_wxfontencodingoverview, GetDefaultEncoding()
+ @see @ref overview_fontencoding, GetDefaultEncoding()
*/
static void SetDefaultEncoding(wxFontEncoding encoding);
A valid facename, which should be on the end-user's system.
@remarks To avoid portability problems, don't rely on a specific face,
- but specify the font family instead or as well. A
- suitable font will be found on the end-user's system.
+ but specify the font family instead or as well.
+ A suitable font will be found on the end-user's system.
If both the family and the facename are specified,
wxWidgets will first search for the specific face, and
then for a font belonging to the same family.
Sets the font family.
@param family
- One of:
- <TABLE>
- <TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
- <TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
- <TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
- <TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
- <TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
- <TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
+ One of the ::wxFontFamily values.
@see GetFamily(), SetFaceName()
*/
void SetFamily(wxFontFamily family);
/**
- Creates the font corresponding to the given native font description string and
- returns @true if
- the creation was successful.
- which must have been previously returned by
- GetNativeFontInfoDesc(). If the string is
- invalid, font is unchanged. This function is typically used for de-serializing
- a wxFont
- object previously saved in a string-form.
+ Creates the font corresponding to the given native font description string
+ which must have been previously returned by GetNativeFontInfoDesc().
+
+ If the string is invalid, font is unchanged.
+ This function is typically used for de-serializing a wxFont object
+ previously saved in a string-form.
+
+ @return @true if the creation was successful.
@see SetNativeFontInfoUserDesc()
*/
/**
Creates the font corresponding to the given native font description string and
- returns @true if
- the creation was successful.
- Unlike SetNativeFontInfo(), this function accepts
- strings which are user-friendly.
- Examples of accepted string formats are:
-
- Generic syntax
-
- Example
-
- on @b wxGTK2: @c [FACE-NAME] [bold] [oblique|italic] [POINTSIZE]
-
- Monospace bold 10
+ returns @true if the creation was successful.
- on @b wxMSW: @c [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING]
-
- Tahoma 10 WINDOWS-1252
+ Unlike SetNativeFontInfo(), this function accepts strings which are user-friendly.
+ Examples of accepted string formats are:
- on @b wxMac: FIXME
+ @beginTable
+ @hdr3col{platform, generic syntax, example}
+ @row3col{wxGTK2, @c [FACE-NAME] [bold] [oblique|italic] [POINTSIZE], Monospace bold 10}
+ @row3col{wxMSW, @c [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING], Tahoma 10 WINDOWS-1252}
+ @endTable
- FIXME
+ @todo add an example for wxMac
For more detailed information about the allowed syntaxes you can look at the
- documentation of the native API used for font-rendering (e.g. pango_font_description_from_string).
+ documentation of the native API used for font-rendering
+ (e.g. @c pango_font_description_from_string on GTK).
@see SetNativeFontInfo()
*/
Sets the font style.
@param style
- One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
+ One of the ::wxFontStyle enumeration values.
@see GetStyle()
*/
- void SetStyle(int style);
+ void SetStyle(wxFontStyle style);
/**
Sets underlining.
Sets the font weight.
@param weight
- One of:
- <TABLE>
- <TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
- <TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
- </TABLE>
+ One of the ::wxFontWeight values.
@see GetWeight()
*/
/**
Inequality operator.
+
See @ref overview_refcountequality "reference-counted object comparison" for
more info.
*/
bool operator !=(const wxFont& font);
- /**
- Assignment operator, using @ref overview_trefcount "reference counting".
- */
- wxFont operator =(const wxFont& font);
-
/**
Equality operator.
+
See @ref overview_refcountequality "reference-counted object comparison" for
more info.
*/
bool operator ==(const wxFont& font);
+
+ /**
+ Assignment operator, using @ref overview_refcount "reference counting".
+ */
+ wxFont& operator =(const wxFont& font);
};
wxFont wxNullFont;
/**
- FIXME
+ Equivalent to wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT).
*/
wxFont wxNORMAL_FONT;
/**
- FIXME
+ A font using the wxFONTFAMILY_SWISS family and 2 points smaller than
+ ::wxNORMAL_FONT.
*/
wxFont wxSMALL_FONT;
/**
- FIXME
+ A font using the wxFONTFAMILY_ROMAN family and wxFONTSTYLE_ITALIC style and
+ of the same size of ::wxNORMAL_FONT.
*/
wxFont wxITALIC_FONT;
/**
- FIXME
+ A font identic to ::wxNORMAL_FONT except for the family used which is
+ wxFONTFAMILY_SWISS.
*/
wxFont wxSWISS_FONT;
/**
@class wxFontList
- A font list is a list containing all fonts which have been created. There
- is only one instance of this class: @b wxTheFontList. Use this object to search
- for a previously created font of the desired type and create it if not already
- found.
+ A font list is a list containing all fonts which have been created.
+ There is only one instance of this class: ::wxTheFontList.
+
+ Use this object to search for a previously created font of the desired type
+ and create it if not already found.
+
In some windowing systems, the font may be a scarce resource, so it is best to
reuse old resources if possible. When an application finishes, all fonts will
- be
- deleted and their resources freed, eliminating the possibility of 'memory
+ be deleted and their resources freed, eliminating the possibility of 'memory
leaks'.
@library{wxcore}
public:
/**
Constructor. The application should not construct its own font list:
- use the object pointer @b wxTheFontList.
+ use the object pointer ::wxTheFontList.
*/
wxFontList();
/**
Finds a font of the given specification, or creates one and adds it to the
- list. See the @ref wxFont::ctor "wxFont constructor" for
- details of the arguments.
+ list. See the @ref wxFont "wxFont constructor" for details of the arguments.
*/
wxFont* FindOrCreateFont(int point_size, int family, int style,
int weight,
};
+/**
+ The global wxFontList instance.
+*/
+wxFontList* wxTheFontList;
+
// ============================================================================
// Global functions/macros
class wxFontDialog : public wxDialog
{
public:
- //@{
/**
- Constructor. Pass a parent window, and optionally the
- @ref overview_wxfontdata "font data" object to be used to initialize the dialog
- controls. If the default constructor is used,
- Create() must be called before the dialog can be
- shown.
+ Default ctor.
+ Create() must be called before the dialog can be shown.
*/
wxFontDialog();
+
+ /**
+ Constructor with parent window.
+ */
wxFontDialog(wxWindow* parent);
+
+ /**
+ Constructor.
+ Pass a parent window, and the @ref overview_wxfontdata "font data" object
+ to be used to initialize the dialog controls.
+ */
wxFontDialog(wxWindow* parent, const wxFontData& data);
- //@}
- //@{
/**
- Creates the dialog if it the wxFontDialog object had been initialized using the
- default constructor. Returns @true on success and @false if an error
- occurred.
+ Creates the dialog if the wxFontDialog object had been initialized using
+ the default constructor.
+
+ @return @true on success and @false if an error occurred.
*/
bool Create(wxWindow* parent);
+
+ /**
+ Creates the dialog if the wxFontDialog object had been initialized using
+ the default constructor.
+
+ @return @true on success and @false if an error occurred.
+ */
bool Create(wxWindow* parent, const wxFontData& data);
- //@}
//@{
/**
- Returns the @ref overview_wxfontdata "font data" associated with the font
- dialog.
+ Returns the @ref overview_wxfontdata "font data" associated with the
+ font dialog.
*/
- const wxFontData GetFontData();
- const wxFontData& GetFontData();
+ const wxFontData& GetFontData() const;
+ wxFontData& GetFontData();
//@}
/**
Shows the dialog, returning @c wxID_OK if the user pressed Ok, and
@c wxID_CANCEL otherwise.
+
If the user cancels the dialog (ShowModal returns @c wxID_CANCEL), no font
will be created. If the user presses OK, a new wxFont will be created and
stored in the font dialog's wxFontData structure.
+
+ @see GetFontData()
*/
int ShowModal();
};
wxFontEnumerator enumerates either all available fonts on the system or only
the ones with given attributes - either only fixed-width (suited for use in
programs such as terminal emulators and the like) or the fonts available in
- the given encoding().
+ the given encoding).
To do this, you just have to call one of EnumerateXXX() functions - either
- wxFontEnumerator::EnumerateFacenames or
- wxFontEnumerator::EnumerateEncodings and the
- corresponding callback (wxFontEnumerator::OnFacename or
- wxFontEnumerator::OnFontEncoding) will be called
- repeatedly until either all fonts satisfying the specified criteria are
- exhausted or the callback returns @false.
+ wxFontEnumerator::EnumerateFacenames() or wxFontEnumerator::EnumerateEncodings()
+ and the corresponding callback (wxFontEnumerator::OnFacename() or
+ wxFontEnumerator::OnFontEncoding()) will be called repeatedly until either
+ all fonts satisfying the specified criteria are exhausted or the callback
+ returns @false.
+
+ @section fontenum_virtual Virtual functions to override
+
+ Either OnFacename or OnFontEncoding should be overridden depending on
+ whether you plan to call EnumerateFacenames or EnumerateEncodings.
+ Of course, if you call both of them, you should override both functions.
@library{wxcore}
- @category{FIXME}
+ @category{gdi}
- @see @ref overview_wxfontencodingoverview, @ref overview_samplefont "Font
- sample", wxFont, wxFontMapper
+ @see @ref overview_fontencoding, @ref sample_font, wxFont, wxFontMapper
*/
class wxFontEnumerator
{
public:
/**
- Call OnFontEncoding() for each
- encoding supported by the given font - or for each encoding supported by at
- least some font if @a font is not specified.
+ Call OnFontEncoding() for each encoding supported by the given font -
+ or for each encoding supported by at least some font if @a font is not specified.
*/
virtual bool EnumerateEncodings(const wxString& font = "");
/**
- Call OnFacename() for each font which
- supports given encoding (only if it is not wxFONTENCODING_SYSTEM) and is of
- fixed width (if @a fixedWidthOnly is @true).
+ Call OnFacename() for each font which supports given encoding (only if
+ it is not @c wxFONTENCODING_SYSTEM) and is of fixed width
+ (if @a fixedWidthOnly is @true).
+
Calling this function with default arguments will result in enumerating all
fonts available on the system.
*/
/**
Returns @true if the given string is valid face name, i.e. it's the face name
- of an installed
- font and it can safely be used with wxFont::SetFaceName.
+ of an installed font and it can safely be used with wxFont::SetFaceName.
*/
static bool IsValidFacename(const wxString& facename);
/**
- Called by EnumerateFacenames() for
- each match. Return @true to continue enumeration or @false to stop it.
+ Called by EnumerateFacenames() for each match.
+
+ Return @true to continue enumeration or @false to stop it.
*/
virtual bool OnFacename(const wxString& font);
/**
- Called by EnumerateEncodings() for
- each match. Return @true to continue enumeration or @false to stop it.
+ Called by EnumerateEncodings() for each match.
+
+ Return @true to continue enumeration or @false to stop it.
*/
virtual bool OnFontEncoding(const wxString& font,
const wxString& encoding);
projects / wxWidgets.git / commitdiff
