Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed trailing whitespace in Doxygen files

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52634 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-03-20 13:45:17 +00:00
parent 7df4c51f60
commit 3c4f71cc3d
184 changed files with 4902 additions and 4902 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
interface/aboutdlg.h
View File

@@ -47,21 +47,21 @@ public:
/**
Adds an artist name to be shown in the program credits.
@see SetArtists()
*/
void AddArtist(const wxString& artist);
/**
Adds a developer name to be shown in the program credits.
@see SetDevelopers()
*/
void AddDeveloper(const wxString& developer);
/**
Adds a documentation writer name to be shown in the program credits.
@see SetDocWriters()
*/
void AddDocWriter(const wxString& docwriter);
@@ -72,14 +72,14 @@ public:
translation of the string @c translator-credits from the currently used message
catalog -- this can be used to show just the name of the translator of the
program in the current language.
@see SetTranslators()
*/
void AddTranslator(const wxString& translator);
/**
Sets the the list of artists to be shown in the program credits.
@see AddArtist()
*/
void SetArtists(const wxArrayString& artists);
@@ -99,14 +99,14 @@ public:
/**
Set the list of developers of the program.
@see AddDeveloper()
*/
void SetDevelopers(const wxArrayString& developers);
/**
Set the list of documentation writers.
@see AddDocWriter()
*/
void SetDocWriters(const wxArrayString& docwriters);

8
interface/accel.h
View File

@@ -77,7 +77,7 @@ public:
/**
Sets the accelerator entry parameters.
@param flags
A combination of the wxAcceleratorEntryFlags values, which
indicates which modifier keys are held down.
@@ -138,7 +138,7 @@ public:
/**
Initializes the accelerator table from an array of wxAcceleratorEntry.
@param n
Number of accelerator entries.
@param entries
@@ -148,7 +148,7 @@ public:
/**
Loads the accelerator table from a Windows resource (Windows only).
@param resource
Name of a Windows accelerator.
*/
@@ -167,7 +167,7 @@ public:
/**
Assignment operator, using @ref overview_refcount "reference counting".
@param accel
Accelerator table to assign.
*/

2
interface/access.h
View File

@@ -382,7 +382,7 @@ public:
/**
Returns a status value and object id to indicate whether the given point
was on this or a child object. Can return either a child object, or an
was on this or a child object. Can return either a child object, or an
integer representing the child element, starting from 1.
@a pt is in screen coordinates.

16
interface/animate.h
View File

@@ -70,11 +70,11 @@ public:
/**
Creates the control with the given @a anim animation.
After control creation you must explicitely call Play() to start to play
the animation. Until that function won't be called, the first frame
of the animation is displayed.
@param parent
Parent window, must be non-@NULL.
@param id
@@ -89,7 +89,7 @@ public:
The window style, see wxAC_* flags.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@@ -192,7 +192,7 @@ public:
/**
Loads an animation from a file.
@param name
The name of the file to load.
@param type
@@ -235,7 +235,7 @@ public:
/**
Loads an animation from the given stream.
@param stream
The stream to use to load the animation.
@param type
@@ -243,7 +243,7 @@ public:
@li wxANIMATION_TYPE_GIF: loads an animated GIF file;
@li wxANIMATION_TYPE_ANI: load an ANI file;
@li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
*/
bool Load(wxInputStream& stream,
@@ -251,13 +251,13 @@ public:
/**
Loads an animation from a file.
@param name
A filename.
@param type
One of the wxAnimationType values; wxANIMATION_TYPE_ANY
means that the function should try to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
*/
bool LoadFile(const wxString& name,

78
interface/app.h
View File

@@ -48,14 +48,14 @@ public:
/**
Creates a wxLog class for the application to use for logging errors.
The default implementation returns a new wxLogGui class.
@see wxLog
*/
virtual wxLog* CreateLogTarget();
/**
Creates the wxAppTraits object when GetTraits() needs it for the first time.
@see wxAppTraits
*/
virtual wxAppTraits* CreateTraits();
@@ -68,7 +68,7 @@ public:
while (app.Pending())
Dispatch();
@endcode
@see Pending()
*/
virtual void Dispatch();
@@ -92,24 +92,24 @@ public:
int FilterEvent(wxEvent& event);
/**
Returns the user-readable application name.
Returns the user-readable application name.
The difference between this string and the one returned by GetAppName() is that
this one is meant to be shown to the user and so should be used for the window
titles, page headers and so on while the other one should be only used internally,
e.g. for the file names or configuration file keys.
By default, returns the same string as GetAppName().
@wxsince{2.9.0}
*/
wxString GetAppDisplayName() const;
/**
Returns the application name.
@remarks wxWidgets sets this to a reasonable default before calling
OnInit(), but the application can reset it at will.
@see GetAppDisplayName()
*/
wxString GetAppName() const;
@@ -117,7 +117,7 @@ public:
/**
Gets the class name of the application. The class name may be used in a
platform specific manner to refer to the application.
@see SetClassName()
*/
wxString GetClassName() const;
@@ -125,7 +125,7 @@ public:
/**
Returns @true if the application will exit when the top-level window is
deleted, @false otherwise.
@see SetExitOnFrameDelete(), @ref overview_app_shutdown
*/
bool GetExitOnFrameDelete() const;
@@ -133,18 +133,18 @@ public:
/**
Returns the one and only global application object.
Usually ::wxTheApp is usead instead.
@see SetInstance()
*/
static wxAppConsole* GetInstance();
/**
Returns a pointer to the top window.
@remarks If the top window hasn't been set using SetTopWindow(),
this function will find the first top-level window
(frame or dialog) and return that.
@see SetTopWindow()
*/
virtual wxWindow* GetTopWindow() const;
@@ -159,7 +159,7 @@ public:
/**
Returns @true if the application will use the best visual on systems that support
different visuals, @false otherwise.
@see SetUseBestVisual()
*/
bool GetUseBestVisual() const;
@@ -172,7 +172,7 @@ public:
configuration file keys.
By default, returns the same string as GetVendorName().
@wxsince{2.9.0}
*/
wxString GetVendorDisplayName() const;
@@ -196,7 +196,7 @@ public:
/**
Returns @true if the application is active, i.e. if one of its windows is
currently in the foreground.
If this function returns @false and you need to attract users attention to
the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
*/
@@ -245,7 +245,7 @@ public:
/**
Called by wxWidgets on creation of the application. Override this if you wish
to provide your own (environment-dependent) main loop.
@returns Returns 0 under X, and the wParam of the WM_QUIT message under
Windows.
*/
@@ -259,7 +259,7 @@ public:
asserts are not left in the release code at all.
The base class version shows the default assert failure dialog box proposing to
the user to stop the program, continue or ignore all subsequent asserts.
@param file
the name of the source file where the assert occurred
@param line
@@ -285,7 +285,7 @@ public:
Return @true to continue normal execution or @false to return
@false from OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineError(wxCmdLineParser& parser);
@@ -296,7 +296,7 @@ public:
Return @true to continue normal execution or @false to return
@false from OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineHelp(wxCmdLineParser& parser);
@@ -310,7 +310,7 @@ public:
processing of the standard command line options.
Return @true to continue normal execution or @false to return @false from
OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineParsed(wxCmdLineParser& parser);
@@ -353,7 +353,7 @@ public:
Generally speaking, this function should only show a message to the user and
return. You may attempt to save unsaved data but this is not guaranteed to
work and, in fact, probably won't.
@see wxHandleFatalExceptions()
*/
void OnFatalException();
@@ -408,7 +408,7 @@ public:
/**
Returns @true if unprocessed events are in the window system event queue.
@see Dispatch()
*/
virtual bool Pending();
@@ -420,9 +420,9 @@ public:
The function returns @true if the message was processed, @false otherwise.
If you use wxWidgets with another class library with its own message loop,
you should make sure that this function is called to allow wxWidgets to
receive messages. For example, to allow co-existence with the Microsoft
receive messages. For example, to allow co-existence with the Microsoft
Foundation Classes, override the PreTranslateMessage function:
@code
// Provide wxWidgets message loop compatibility
BOOL CTheApp::PreTranslateMessage(MSG *msg)
@@ -440,11 +440,11 @@ public:
Sends idle events to a window and its children.
Please note that this function is internal to wxWidgets and shouldn't be used
by user code.
@remarks These functions poll the top-level windows, and their children,
for idle event processing. If @true is returned, more OnIdle
processing is requested by one or more window.
@see wxIdleEvent
*/
bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
@@ -463,7 +463,7 @@ public:
SetAppDisplayName() is used instead.
By default the application name is set to the name of its executable file.
@see GetAppName()
*/
void SetAppName(const wxString& name);
@@ -471,7 +471,7 @@ public:
/**
Sets the class name of the application. This may be used in a platform specific
manner to refer to the application.
@see GetClassName()
*/
void SetClassName(const wxString& name);
@@ -479,11 +479,11 @@ public:
/**
Allows the programmer to specify whether the application will exit when the
top-level frame is deleted.
@param flag
If @true (the default), the application will exit when the top-level frame
is deleted. If @false, the application will continue to run.
@see GetExitOnFrameDelete(), @ref overview_app_shutdown
*/
void SetExitOnFrameDelete(bool flag);
@@ -491,10 +491,10 @@ public:
/**
Allows external code to modify global ::wxTheApp, but you should really
know what you're doing if you call it.
@param app
Replacement for the global application object.
@see GetInstance()
*/
static void SetInstance(wxAppConsole* app);
@@ -504,7 +504,7 @@ public:
Currently implemented for wxGTK2-only.
Return @true if theme was successfully changed.
@param theme
The name of the new theme or an absolute path to a gtkrc-theme-file
*/
@@ -517,10 +517,10 @@ public:
can use a specific window as the top window. If no top window is specified by the
application, wxWidgets just uses the first frame or dialog in its top-level window
list, when it needs to use the top window.
@param window
The new top window.
@see GetTopWindow(), OnInit()
*/
void SetTopWindow(wxWindow* window);
@@ -534,7 +534,7 @@ public:
Note that this function has to be called in the constructor of the wxApp
instance and won't have any effect when called later on.
This function currently only has effect under GTK.
@param flag
If @true, the app will use the best visual.
@param forceTrueColour
@@ -553,7 +553,7 @@ public:
/**
Sets the name of application's vendor. The name will be used
in registry access. A default name is set by wxWidgets.
@see GetVendorName()
*/
void SetVendorName(const wxString& name);
@@ -783,7 +783,7 @@ int wxEntry(int& argc, wxChar** argv);
// OnExit isn't called by CleanUp so must be called explicitly.
wxTheApp->OnExit();
wxApp::CleanUp();
return CWinApp::ExitInstance();
}
@endcode

12
interface/archive.h
View File

@@ -240,7 +240,7 @@ public:
The names of directory entries are returned without any trailing path
separator. This gives a canonical name that can be used in comparisons.
@see @ref overview_archive_byname
*/
wxString GetInternalName() const;
@@ -327,7 +327,7 @@ enum wxStreamProtocolType
wxArchiveClassFactory::Find can also search for a factory by MIME type
or wxFileSystem protocol.
The available factories can be enumerated using
The available factories can be enumerated using
wxArchiveClassFactory::GetFirst() and wxArchiveClassFactory::GetNext().
@library{wxbase}
@@ -381,13 +381,13 @@ public:
@code
wxString list;
const wxArchiveClassFactory *factory = wxArchiveClassFactory::GetFirst();
while (factory) {
list << factory->GetProtocol() << _T("\n");
factory = factory->GetNext();
}
@endcode
GetFirst() and GetNext() return a pointer to a factory or @NULL if no more
are available. They do not give away ownership of the factory.
*/
@@ -418,7 +418,7 @@ public:
@code
wxString list;
const wxChar *const *p;
for (p = factory->GetProtocols(wxSTREAM_FILEEXT); *p; p++)
list << *p << _T("\n");
@encode
@@ -529,7 +529,7 @@ public:
The first template parameter should be the type of archive input stream
(e.g. wxArchiveInputStream) and the second can either be a pointer to an entry
(e.g. wxArchiveEntry*), or a string/pointer pair (e.g. std::pairwxString,
(e.g. wxArchiveEntry*), or a string/pointer pair (e.g. std::pairwxString,
wxArchiveEntry*).
The @c wx/archive.h header defines the following typedefs:

16
interface/arrstr.h
View File

@@ -116,7 +116,7 @@ public:
/**
Empties the array: after a call to this function GetCount() will return 0.
However, this function does not free the memory used by the array and so
However, this function does not free the memory used by the array and so
should be used when the array is going to be reused for storing other strings.
Otherwise, you should use Clear() to empty the array and free memory.
*/
@@ -146,7 +146,7 @@ public:
@code
Insert("foo", 0);
@endcode
If @a nIndex is equal to @e GetCount() this function behaves as Add().
*/
void Insert(const wxString& str, size_t nIndex,
@@ -207,7 +207,7 @@ public:
/**
Sorts the array using the specified @a compareFunction for item comparison.
@e CompareFunction is defined as a function taking two @e const wxString
parameters and returning an @e int value less than, equal to or greater
parameters and returning an @e int value less than, equal to or greater
than 0 if the first string is less than, equal to or greater than the
second one.
@@ -219,16 +219,16 @@ public:
{
return first.length() - second.length();
}
...
wxArrayString array;
array.Add("one");
array.Add("two");
array.Add("three");
array.Add("four");
array.Sort(CompareStringLen);
@endcode
*/
@@ -307,7 +307,7 @@ public:
/**
@copydoc wxArrayString::Index()
This function uses binary search for wxSortedArrayString, but it ignores
This function uses binary search for wxSortedArrayString, but it ignores
the @a bCase and @a bFromEnd parameters.
*/
int Index(const wxString& sz, bool bCase = true,

32
interface/artprov.h
View File

@@ -132,14 +132,14 @@
Client is the entity that calls wxArtProvider's GetBitmap or GetIcon function.
It is represented by wxClientID type and can have one of these values:
@li wxART_TOOLBAR
@li wxART_MENU
@li wxART_BUTTON
@li wxART_FRAME_ICON
@li wxART_CMN_DIALOG
@li wxART_HELP_BROWSER
@li wxART_MESSAGE_BOX
@li wxART_OTHER (used for all requests that don't fit into any of the
@li wxART_TOOLBAR
@li wxART_MENU
@li wxART_BUTTON
@li wxART_FRAME_ICON
@li wxART_CMN_DIALOG
@li wxART_HELP_BROWSER
@li wxART_MESSAGE_BOX
@li wxART_OTHER (used for all requests that don't fit into any of the
categories above)
Client ID servers as a hint to wxArtProvider that is supposed to help it to
@@ -168,7 +168,7 @@ public:
resource. Note that returned bitmaps are cached by wxArtProvider and it is
therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
create wxBitmap objects from XPMs here).
@param id
wxArtID unique identifier of the bitmap.
@param client
@@ -182,7 +182,7 @@ public:
This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
for a resource.
@see CreateIconBundle()
*/
wxBitmap CreateBitmap(const wxArtID& id,
@@ -203,14 +203,14 @@ public:
/**
Query registered providers for bitmap with given ID.
@param id
wxArtID unique identifier of the bitmap.
@param client
wxArtClient identifier of the client (i.e. who is asking for the bitmap).
@param size
Size of the returned bitmap or wxDefaultSize if size doesn't matter.
@returns The bitmap if one of registered providers recognizes the ID or
wxNullBitmap otherwise.
*/
@@ -238,13 +238,13 @@ public:
/**
Query registered providers for icon bundle with given ID.
@param id
wxArtID unique identifier of the icon bundle.
@param client
wxArtClient identifier of the client (i.e. who is asking for the icon
bundle).
@returns The icon bundle if one of registered providers recognizes the ID
or wxNullIconBundle otherwise.
*/
@@ -254,7 +254,7 @@ public:
/**
Register new art provider and add it to the bottom of providers stack
(i.e. it will be queried as the last one).
@see Push()
*/
static void Insert(wxArtProvider* provider);
@@ -267,7 +267,7 @@ public:
/**
Register new art provider and add it to the top of providers stack
(i.e. it will be queried as the first provider).
@see Insert()
*/
static void Push(wxArtProvider* provider);

4
interface/base64.h
View File

@@ -103,7 +103,7 @@ size_t wxBase64EncodedSize(size_t len);
The length of the input string or special value wxNO_LEN if the string is
NUL-terminated and the length should be computed by this function itself.
@param mode
This parameter specifies the function behaviour when invalid characters
This parameter specifies the function behaviour when invalid characters
are encountered in input. By default, any such character stops the
decoding with error. If the mode is wxBase64DecodeMode_SkipWS, then the
white space characters are silently skipped instead. And if it is
@@ -125,7 +125,7 @@ size_t wxBase64Decode(void* dst, size_t dstLen,
This overload allocates memory internally and returns it as wxMemoryBuffer
and is recommended for normal use.
This overload returns a buffer with the base64 decoded binary equivalent
This overload returns a buffer with the base64 decoded binary equivalent
of the input string. In neither case is the buffer @NULL-terminated.
*/
wxMemoryBuffer wxBase64Decode(const char* src,

12
interface/calctrl.h
View File

@@ -278,42 +278,42 @@ public:
/**
Gets the background colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourBg() const;
/**
Gets the foreground colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourFg() const;
/**
Gets the background highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourBg() const;
/**
Gets the foreground highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourFg() const;
/**
Return the background colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourBg() const;
/**
Return the foreground colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourFg() const;

20
interface/caret.h
View File

@@ -58,13 +58,13 @@ public:
//@{
/**
Get the caret position (in pixels).
@b GetPosition()
Returns a Wx::Point
@b GetPositionXY()
Returns a 2-element list
@c ( x, y )
*/
@@ -75,13 +75,13 @@ public:
//@{
/**
Get the caret size.
@b GetSize()
Returns a Wx::Size
@b GetSizeWH()
Returns a 2-element list
@c ( width, height )
*/
@@ -121,11 +121,11 @@ public:
/**
Sets the blink time for all the carets.
@remarks Under Windows, this function will change the blink time for all
carets permanently (until the next time it is called),
even for the carets in other applications.
@see GetBlinkTime()
*/
static void SetBlinkTime(int milliseconds);

14
interface/checkbox.h
View File

@@ -47,7 +47,7 @@ public:
//@{
/**
Constructor, creating and showing a checkbox.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -66,7 +66,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxCheckBox();
@@ -98,7 +98,7 @@ public:
/**
Gets the state of a 3-state checkbox.
@returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
wxCHK_CHECKED when it is checked and
wxCHK_UNDETERMINED when it's in the undetermined state.
@@ -109,14 +109,14 @@ public:
/**
Gets the state of a 2-state checkbox.
@returns Returns @true if it is checked, @false otherwise.
*/
bool GetValue() const;
/**
Returns whether or not the checkbox is a 3-state checkbox.
@returns Returns @true if this checkbox is a 3-state checkbox, @false if
it's a 2-state checkbox.
*/
@@ -124,7 +124,7 @@ public:
/**
Returns whether or not the user can set the checkbox to the third state.
@returns Returns @true if the user can set the third state of this
checkbox, @false if it can only be set programmatically
or if it's a 2-state checkbox.
@@ -141,7 +141,7 @@ public:
/**
Sets the checkbox to the given state. This does not cause a
wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
@param state
If @true, the check is on, otherwise it is off.
*/

4
interface/checklst.h
View File

@@ -38,7 +38,7 @@ public:
//@{
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -86,7 +86,7 @@ public:
/**
Checks the given item. Note that calling this method doesn't result in
wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
@param item
Index of item to check.
@param check

10
interface/choice.h
View File

@@ -37,7 +37,7 @@ public:
//@{
/**
Constructor, creating and showing a choice.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -58,7 +58,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxChoice();
@@ -104,7 +104,7 @@ public:
/**
Gets the number of columns in this choice item.
@remarks This is implemented for Motif only and always returns 1 for the
other platforms.
*/
@@ -117,7 +117,7 @@ public:
That is, while the dropdown list is shown, it returns the currently selected
item in it. When it is not shown, its result is the same as for the other
function.
@wxsince{2.6.2} (before this version
wxControlWithItems::GetSelection itself behaved like
this).
@@ -126,7 +126,7 @@ public:
/**
Sets the number of columns in this choice item.
@param n
Number of columns.
*/

4
interface/clipbrd.h
View File

@@ -77,7 +77,7 @@ public:
After this function has been called, the clipboard owns the data, so do not
delete
the data explicitly.
@see SetData()
*/
bool AddData(wxDataObject* data);
@@ -141,7 +141,7 @@ public:
After this function has been called, the clipboard owns the data, so do not
delete
the data explicitly.
@see AddData()
*/
bool SetData(wxDataObject* data);

4
interface/clntdata.h
View File

@@ -30,12 +30,12 @@ class wxClientDataContainer
{
public:
/**
*/
wxClientDataContainer();
/**
*/
~wxClientDataContainer();

2
interface/clrpicker.h
View File

@@ -69,7 +69,7 @@ public:
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.
*/

8
interface/cmdline.h
View File

@@ -104,7 +104,7 @@ public:
/**
Returns @true if long options are enabled, otherwise @false.
@see EnableLongOptions()
*/
bool AreLongOptionsEnabled() const;
@@ -174,7 +174,7 @@ public:
Enable or disable support for the long options.
As long options are not (yet) POSIX-compliant, this option allows to disable
them.
@see Customization() and AreLongOptionsEnabled()
*/
void EnableLongOptions(bool enable = true);
@@ -219,7 +219,7 @@ public:
Parse the command line, return 0 if ok, -1 if @c "-h" or @c "--help"
option was encountered and the help message was given or a positive value if a
syntax error occurred.
@param giveUsage
If @true (default), the usage message is given if a
syntax error was encountered while parsing the command line or if help was
@@ -273,7 +273,7 @@ public:
Give the standard usage message describing all program options. It will use the
options and parameters descriptions specified earlier, so the resulting message
will not be helpful to the user unless the descriptions were indeed specified.
@see SetLogo()
*/
void Usage() const;

4
interface/cmndata.h
View File

@@ -493,7 +493,7 @@ public:
Returns the current print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.
@@ -557,7 +557,7 @@ public:
Sets the desired print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.

2
interface/collpane.h
View File

@@ -136,7 +136,7 @@ public:
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.
*/

2
interface/colordlg.h
View File

@@ -28,7 +28,7 @@ public:
Invalid entries in custom colours list will be ignored on some platforms (GTK)
or replaced with white colour on platforms where custom colours palette has
fixed size (MSW).
@see wxColourData
*/
wxColourDialog(wxWindow* parent, wxColourData* data = NULL);

10
interface/colour.h
View File

@@ -35,7 +35,7 @@ public:
//@{
/**
Copy constructor.
@param red
The red value.
@param green
@@ -49,7 +49,7 @@ public:
The colour name.
@param colour
The colour to copy.
@see wxColourDatabase
*/
wxColour();
@@ -75,7 +75,7 @@ public:
/**
is not
specified in flags.
@wxsince{2.7.0}
*/
wxString GetAsString(long flags);
@@ -124,7 +124,7 @@ public:
and the HTML-like syntax (i.e. @c "#" followed by 6 hexadecimal digits
for red, green, blue components).
Returns @true if the conversion was successful, @false otherwise.
@wxsince{2.7.0}
*/
void Set(unsigned char red, unsigned char green,
@@ -143,7 +143,7 @@ public:
//@{
/**
Assignment operator, using a colour name to be found in the colour database.
@see wxColourDatabase
*/
wxColour operator =(const wxColour& colour);

60
interface/combo.h
View File

@@ -32,7 +32,7 @@ public:
/**
The derived class must implement this to create the popup control.
@returns @true if the call succeeded, @false otherwise.
*/
bool Create(wxWindow* parent);
@@ -45,7 +45,7 @@ public:
/**
The derived class may implement this to return adjusted size
for the popup control, according to the variables given.
@param minWidth
Preferred minimum width.
@param prefHeight
@@ -54,7 +54,7 @@ public:
@param maxWidth
Max height for window, as limited by
screen size.
@remarks Called each time popup is about to be shown.
*/
wxSize GetAdjustedSize(int minWidth, int prefHeight,
@@ -92,7 +92,7 @@ public:
until the popup is shown for the first time. It is more
efficient, but on the other hand it is often more convenient
to have the control created immediately.
@remarks Base implementation returns @false.
*/
bool LazyCreate();
@@ -192,7 +192,7 @@ public:
//@{
/**
Constructor, creating and showing a combo control.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -211,7 +211,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxComboCtrl();
@@ -233,7 +233,7 @@ public:
This member function is not normally called in application code.
Instead, it can be implemented in a derived class to create a
custom popup animation.
@returns @true if animation finishes before the function returns. @false
otherwise. In the latter case you need to manually call
DoShowPopup after the animation ends.
@@ -279,7 +279,7 @@ public:
is properly shown after a popup animation has finished (but only
if AnimateShow() did not finish
the animation within it's function scope).
@param rect
Position to show the popup window at, in screen coordinates.
@param flags
@@ -296,7 +296,7 @@ public:
/**
Returns disabled button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the disabled state bitmap.
*/
const wxBitmap GetBitmapDisabled() const;
@@ -304,7 +304,7 @@ public:
/**
Returns button mouse hover bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the mouse hover state bitmap.
*/
const wxBitmap GetBitmapHover() const;
@@ -312,7 +312,7 @@ public:
/**
Returns default button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the normal state bitmap.
*/
const wxBitmap GetBitmapNormal() const;
@@ -320,7 +320,7 @@ public:
/**
Returns depressed button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the depressed state bitmap.
*/
const wxBitmap GetBitmapPressed() const;
@@ -332,7 +332,7 @@ public:
/**
Returns custom painted area in control.
@see SetCustomPaintWidth().
*/
int GetCustomPaintWidth() const;
@@ -341,7 +341,7 @@ public:
Returns features supported by wxComboCtrl. If needed feature is missing,
you need to instead use wxGenericComboCtrl, which however may lack
native look and feel (but otherwise sports identical API).
@returns Value returned is a combination of following flags:
*/
static int GetFeatures();
@@ -403,18 +403,18 @@ public:
/**
Returns @true if the popup window is in the given state.
Possible values are:
@c Hidden()
Popup window is hidden.
@c Animating()
Popup window is being shown, but the
popup animation has not yet finished.
@c Visible()
Popup window is fully visible.
*/
bool IsPopupWindowState(int state) const;
@@ -437,7 +437,7 @@ public:
/**
Removes the text between the two positions in the combo control text field.
@param from
The first position.
@param to
@@ -448,7 +448,7 @@ public:
/**
Replaces the text between two positions with the given text, in the combo
control text field.
@param from
The first position.
@param to
@@ -460,7 +460,7 @@ public:
/**
Sets custom dropdown button graphics.
@param bmpNormal
Default button image.
@param pushButtonBg
@@ -483,7 +483,7 @@ public:
/**
Sets size and position of dropdown button.
@param width
Button width. Value = 0 specifies default.
@param height
@@ -507,7 +507,7 @@ public:
/**
Sets the insertion point in the text field.
@param pos
The new insertion point.
*/
@@ -535,21 +535,21 @@ public:
/**
Extends popup size horizontally, relative to the edges of the combo control.
@param extLeft
How many pixel to extend beyond the left edge of the
control. Default is 0.
@param extRight
How many pixel to extend beyond the right edge of the
control. Default is 0.
@remarks Popup minimum width may override arguments.
*/
void SetPopupExtents(int extLeft, int extRight);
/**
Sets preferred maximum height of the popup.
@remarks Value -1 indicates the default.
*/
void SetPopupMaxHeight(int height);
@@ -557,14 +557,14 @@ public:
/**
Sets minimum width of the popup. If wider than combo control, it will extend to
the left.
@remarks Value -1 indicates the default.
*/
void SetPopupMinWidth(int width);
/**
Selects the text between the two positions, in the combo control text field.
@param from
The first position.
@param to

14
interface/combobox.h
View File

@@ -66,7 +66,7 @@ public:
//@{
/**
Constructor, creating and showing a combobox.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -89,7 +89,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxComboBox();
@@ -229,7 +229,7 @@ public:
/**
Removes the text between the two positions in the combobox text field.
@param from
The first position.
@param to
@@ -240,7 +240,7 @@ public:
/**
Replaces the text between two positions with the given text, in the combobox
text field.
@param from
The first position.
@param to
@@ -252,7 +252,7 @@ public:
/**
Sets the insertion point in the combobox text field.
@param pos
The new insertion point.
*/
@@ -265,7 +265,7 @@ public:
/**
Selects the text between the two positions, in the combobox text field.
@param from
The first position.
@param to
@@ -277,7 +277,7 @@ public:
Sets the text for the combobox text field.
@b NB: For a combobox with @c wxCB_READONLY style the string must be in
the combobox choices list, otherwise the call to SetValue() is ignored.
@param text
The text to set.
*/

98
interface/config.h
View File

@@ -41,7 +41,7 @@ public:
)
This is the default and only constructor of the wxConfigBase class, and
derived classes.
@param appName
The application name. If this is empty, the class will
normally use wxApp::GetAppName to set it. The
@@ -101,7 +101,7 @@ public:
This parameter is only used by wxFileConfig when compiled
in Unicode mode. It specifies the encoding in which the configuration file
is written.
@remarks By default, environment variable expansion is on and recording
defaults is off.
*/
@@ -118,7 +118,7 @@ public:
/**
@ref ctor() wxConfigBase
@ref dtor() ~wxConfigBase
*/
@@ -136,9 +136,9 @@ public:
config file. @e DeleteAll() is especially useful if you want to erase all
traces of your program presence: for example, when you uninstall it.
DeleteEntry()
DeleteGroup()
DeleteAll()
*/
@@ -182,19 +182,19 @@ public:
from running several enumerations simultaneously, that's why you must pass it
explicitly.
Having said all this, enumerating the config entries/groups is very simple:
There are also functions to get the number of entries/subgroups without
actually enumerating them, but you will probably never need them.
GetFirstGroup()
GetNextGroup()
GetFirstEntry()
GetNextEntry()
GetNumberOfEntries()
GetNumberOfGroups()
*/
@@ -253,7 +253,7 @@ public:
bool GetNextGroup(wxString& str, long& index) const;
/**
*/
uint GetNumberOfEntries(bool bRecursive = false) const;
@@ -309,18 +309,18 @@ public:
Final remark: the @e szKey parameter for all these functions can contain an
arbitrary path (either relative or absolute), not just the key name.
Read()
Write()
Flush()
*/
/**
GetAppName()
GetVendorName()
wxFileConfig::SetUmask
*/
@@ -330,7 +330,7 @@ public:
first of them is the expansion of environment variables in the string values
read from the config file: for example, if you have the following in your
config file:
the call to @c config-Read("UserData") will return something like
@c "/home/zeitlin/data" if you're lucky enough to run a Linux system ;-)
Although this feature is very useful, it may be annoying if you read a value
@@ -341,11 +341,11 @@ public:
would be to prefix the offending symbols with a backslash.
The following functions control this option:
IsExpandingEnvVars()
SetExpandEnvVars()
SetRecordDefaults()
IsRecordingDefaults()
*/
@@ -359,18 +359,18 @@ public:
which makes it possible to use the relative paths. To clarify all this, here
is an example (it is only for the sake of demonstration, it doesn't do anything
sensible!):
@e Warning: it is probably a good idea to always restore the path to its
old value on function exit:
because otherwise the assert in the following example will surely fail
(we suppose here that @e foo() function is the same as above except that it
doesn't save and restore the path):
Finally, the path separator in wxConfigBase and derived classes is always '/',
regardless of the platform (i.e. it is @b not '\\' under Windows).
SetPath()
GetPath()
*/
@@ -382,22 +382,22 @@ public:
returning @true if the value was found.
If the value was not found, @a defaultVal is used instead.
bool Read(const wxStringkey, T* value) const;
@b Read(key, default="")
Returns a string
@b ReadInt(key, default=0)
Returns an integer
@b ReadFloat(key, default=0.0)
Returns a floating point number
@b ReadBool(key, default=0)
Returns a boolean
*/
bool Read(const wxString& key, wxString* str) const;
@@ -453,7 +453,7 @@ public:
the new name already exists or because the function is not supported in this
wxConfig implementation.
RenameEntry()
RenameGroup()
*/
@@ -526,22 +526,22 @@ public:
in it. For example wxFontMapper or Unix version
of wxFileDialog have the ability to use wxConfig class.
Set()
Get()
Create()
DontCreateOnDemand()
*/
/**
HasGroup()
HasEntry()
Exists()
GetEntryType()
*/
@@ -551,22 +551,22 @@ public:
These functions write the specified value to the config file and return @true
on success. In the last one, function wxToString() must be
defined for type @e T.
@b Write(key, value)
Writes a string
@b WriteInt(key, value)
Writes an integer
@b WriteFloat(key, value)
Writes a floating point number
@b WriteBool(key, value)
Writes a boolean
*/
bool Write(const wxString& key, const wxString& value);

4
interface/cshelp.h
View File

@@ -84,7 +84,7 @@ public:
the latter if the help doesn't depend on the position.
Returns @true if help was shown, or @false if no help was available for this
window.
@param window
Window to show help text for.
@param point
@@ -240,7 +240,7 @@ public:
//@{
/**
Constructor, creating and showing a context help button.
@param parent
Parent window. Must not be @NULL.
@param id

58
interface/ctrlsub.h
View File

@@ -45,7 +45,7 @@ public:
Appends several items at once to the control. Notice that calling this method
is usually much faster than appending them one by one if you need to add a lot
of items.
@param item
String to add.
@param stringsArray
@@ -56,7 +56,7 @@ public:
Number of items in the strings array.
@param clientData
Array of client data pointers of size n to associate with the new items.
@returns When appending a single item, the return value is the index of
the newly added item which may be different from the
last one if the control is sorted (e.g. has wxLB_SORT
@@ -86,22 +86,22 @@ public:
Note that it is an error (signalled by an assert failure in debug builds) to
remove an item with the index negative or greater or equal than the number of
items in the control.
@param n
The zero-based item index.
@see Clear()
*/
void Delete(unsigned int n);
/**
Finds an item whose label matches the given string.
@param string
String to find.
@param caseSensitive
Whether search is case sensitive (default is not).
@returns The zero-based position of the item, or wxNOT_FOUND if the
string was not found.
*/
@@ -113,10 +113,10 @@ public:
It is an error to call this function for a control which doesn't have untyped
client data at all although it is ok to call it even if the given item doesn't
have any client data associated with it (but other items do).
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
*/
void* GetClientData(unsigned int n) const;
@@ -126,17 +126,17 @@ public:
It is an error to call this function for a control which doesn't have typed
client data at all although it is ok to call it even if the given item doesn't
have any client data associated with it (but other items do).
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
*/
wxClientData* GetClientObject(unsigned int n) const;
/**
Returns the number of items in the control.
@see IsEmpty()
*/
unsigned int GetCount() const;
@@ -144,23 +144,23 @@ public:
/**
Returns the index of the selected item or @c wxNOT_FOUND if no item is
selected.
@returns The position of the current selection.
@remarks This method can be used with single selection list boxes only,
you should use wxListBox::GetSelections for the list
boxes with wxLB_MULTIPLE style.
@see SetSelection(), GetStringSelection()
*/
int GetSelection() const;
/**
Returns the label of the item with the given index.
@param n
The zero-based index.
@returns The label of the item or an empty string if the position was
invalid.
*/
@@ -169,7 +169,7 @@ public:
/**
Returns the label of the selected item or an empty string if no item is
selected.
@see GetSelection()
*/
wxString GetStringSelection() const;
@@ -185,7 +185,7 @@ public:
is usually much faster than inserting them one by one if you need to insert a
lot
of items.
@param item
String to add.
@param pos
@@ -198,7 +198,7 @@ public:
Number of items in the strings array.
@param clientData
Array of client data pointers of size n to associate with the new items.
@returns The return value is the index of the newly inserted item. If the
insertion failed for some reason, -1 is returned.
*/
@@ -221,7 +221,7 @@ public:
/**
Returns @true if the control is empty or @false if it has some items.
@see GetCount()
*/
bool IsEmpty() const;
@@ -238,7 +238,7 @@ public:
Replaces the current control contents with the given items. Notice that calling
this method is much faster than appending the items one by one if you need to
append a lot of them.
@param item
The single item to insert into the control.
@param stringsArray
@@ -250,7 +250,7 @@ public:
'strings'.
@param clientData
Client data to associate with the item(s).
@returns When the control is sorted (e.g. has wxLB_SORT or wxCB_SORT
style) the return value could be different from
(GetCount() - 1). When setting a single item to the
@@ -274,7 +274,7 @@ public:
Associates the given untyped client data pointer with the given item. Note that
it is an error to call this function if any typed client data pointers had been
associated with the control items before.
@param n
The zero-based item index.
@param data
@@ -289,7 +289,7 @@ public:
control itself is destroyed).
Note that it is an error to call this function if any untyped client data
pointers had been associated with the control items before.
@param n
The zero-based item index.
@param data
@@ -302,17 +302,17 @@ public:
if @a n == @c wxNOT_FOUND.
Note that this does not cause any command events to be emitted nor does it
deselect any other items in the controls which support multiple selections.
@param n
The string position to select, starting from zero.
@see SetString(), SetStringSelection()
*/
void SetSelection(int n);
/**
Sets the label for the given item.
@param n
The zero-based item index.
@param string
@@ -323,10 +323,10 @@ public:
/**
Selects the item with the specified string in the control. This doesn't cause
any command events to be emitted.
@param string
The string to select.
@returns @true if the specified string has been selected, @false if it
wasn't found in the control.
*/

592
interface/cursor.h
View File

@@ -39,7 +39,7 @@ public:
//@{
/**
Copy constructor, uses @ref overview_trefcount "reference counting".
@param bits
An array of bits.
@param maskBits
@@ -58,370 +58,370 @@ public:
it defaults to wxBITMAP_TYPE_CUR_RESOURCE. Under MacOS, it defaults to
wxBITMAP_TYPE_MACCURSOR_RESOURCE.
Under X, the permitted cursor types are:
wxBITMAP_TYPE_XBM
Load an X bitmap file.
Under Windows, the permitted types are:
wxBITMAP_TYPE_CUR
Load a cursor from a .cur cursor file (only if USE_RESOURCE_LOADING_IN_MSW
is enabled in setup.h).
wxBITMAP_TYPE_CUR_RESOURCE
Load a Windows resource (as specified in the .rc file).
wxBITMAP_TYPE_ICO
Load a cursor from a .ico icon file (only if USE_RESOURCE_LOADING_IN_MSW
is enabled in setup.h). Specify hotSpotX and hotSpotY.
@param cursorId
A stock cursor identifier. May be one of:
wxCURSOR_ARROW
A standard arrow cursor.
wxCURSOR_RIGHT_ARROW
A standard arrow cursor
pointing to the right.
wxCURSOR_BLANK
Transparent cursor.
wxCURSOR_BULLSEYE
Bullseye cursor.
wxCURSOR_CHAR
Rectangular character cursor.
wxCURSOR_CROSS
A cross cursor.
wxCURSOR_HAND
A hand cursor.
wxCURSOR_IBEAM
An I-beam cursor (vertical line).
wxCURSOR_LEFT_BUTTON
Represents a mouse with the left button depressed.
wxCURSOR_MAGNIFIER
A magnifier icon.
wxCURSOR_MIDDLE_BUTTON
Represents a mouse with the middle button depressed.
wxCURSOR_NO_ENTRY
A no-entry sign cursor.
wxCURSOR_PAINT_BRUSH
A paintbrush cursor.
wxCURSOR_PENCIL
A pencil cursor.
wxCURSOR_POINT_LEFT
A cursor that points left.
wxCURSOR_POINT_RIGHT
A cursor that points right.
wxCURSOR_QUESTION_ARROW
An arrow and question mark.
wxCURSOR_RIGHT_BUTTON
Represents a mouse with the right button depressed.
wxCURSOR_SIZENESW
A sizing cursor pointing NE-SW.
wxCURSOR_SIZENS
A sizing cursor pointing N-S.
wxCURSOR_SIZENWSE
A sizing cursor pointing NW-SE.
wxCURSOR_SIZEWE
A sizing cursor pointing W-E.
wxCURSOR_SIZING
A general sizing cursor.
wxCURSOR_SPRAYCAN
A spraycan cursor.
wxCURSOR_WAIT
A wait cursor.
wxCURSOR_WATCH
A watch cursor.
wxCURSOR_ARROWWAIT
A cursor with both an arrow and
an hourglass, (windows.)
Note that not all cursors are available on all platforms.
@param cursor
Pointer or reference to a cursor to copy.

36
interface/dataview.h
View File

@@ -67,7 +67,7 @@ class wxDataViewEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxDataViewEvent(wxEventType commandType = wxEVT_NULL,
int winid = 0);
@@ -107,7 +107,7 @@ public:
const wxVariant GetValue() const;
/**
*/
void SetColumn(int col);
@@ -117,12 +117,12 @@ public:
void SetDataViewColumn(wxDataViewColumn* col);
/**
*/
void SetModel(wxDataViewModel* model);
/**
*/
void SetValue(const wxVariant& value);
};
@@ -147,7 +147,7 @@ class wxDataViewIconTextRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewIconTextRenderer(const wxString& varianttype = "wxDataViewIconText",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@@ -584,7 +584,7 @@ public:
*/
virtual bool Activate( wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col );
/**
@@ -626,7 +626,7 @@ public:
virtual bool LeftClick( wxPoint cursor,
wxRect cell,
wxDataViewModel * model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col );
/**
@@ -651,7 +651,7 @@ public:
virtual bool RightClick(wxPoint cursor,
wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col);
/**
@@ -659,7 +659,7 @@ public:
*/
virtual bool StartDrag(wxPoint cursor, wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col);
};
@@ -678,7 +678,7 @@ class wxDataViewBitmapRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewBitmapRenderer(const wxString& varianttype = "wxBitmap",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@@ -756,7 +756,7 @@ class wxDataViewItem
public:
//@{
/**
*/
wxDataViewItem(void* id = NULL);
wxDataViewItem(const wxDataViewItem& item);
@@ -1344,7 +1344,7 @@ class wxDataViewTextRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewTextRenderer(const wxString& varianttype = "string",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@@ -1365,7 +1365,7 @@ class wxDataViewProgressRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewProgressRenderer(const wxString& label = wxEmptyString,
const wxString& varianttype = "long",
@@ -1412,7 +1412,7 @@ class wxDataViewToggleRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewToggleRenderer(const wxString& varianttype = "bool",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@@ -1456,7 +1456,7 @@ public:
~wxDataViewTreeCtrl();
/**
*/
wxDataViewItem AppendContainer(const wxDataViewItem& parent,
const wxString& text,
@@ -1465,7 +1465,7 @@ public:
wxClientData* data = NULL);
/**
*/
wxDataViewItem AppendItem(const wxDataViewItem& parent,
const wxString& text,
@@ -1769,7 +1769,7 @@ class wxDataViewDateRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewDateRenderer(const wxString& varianttype = "datetime",
wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE);
@@ -1795,7 +1795,7 @@ class wxDataViewTextRendererAttr : public wxDataViewTextRenderer
{
public:
/**
*/
wxDataViewTextRendererAttr(const wxString& varianttype = "string",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,

10
interface/datectrl.h
View File

@@ -90,7 +90,7 @@ public:
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.
*/
@@ -107,14 +107,14 @@ public:
SetRange(), returns the lower and upper
bounds of this range. If no range is set (or only one of the bounds is set),
@a dt1 and/or @a dt2 are set to be invalid.
@param dt1
Pointer to the object which receives the lower range limit or
becomes invalid if it is not set. May be @NULL if the caller is not
interested in lower limit
@param dt2
Same as above but for the upper limit
@returns @false if no range limits are currently set, @true if at least one
bound is set.
*/
@@ -131,7 +131,7 @@ public:
control. The native version always uses the current system locale.
Sets the display format for the date in the control. See wxDateTime for the
meaning of format strings.
@remarks If the format parameter is invalid, the behaviour is undefined.
*/
void SetFormat(const wxChar* format);
@@ -140,7 +140,7 @@ public:
Sets the valid range for the date selection. If @a dt1 is valid, it becomes
the earliest date (inclusive) accepted by the control. If @a dt2 is valid,
it becomes the latest possible date.
@remarks If the current value of the control is outside of the newly set
range bounds, the behaviour is undefined.
*/

370
interface/datetime.h
View File

@@ -35,39 +35,39 @@ public:
some more complicated calculations to find the answer are under the
@ref overview_datetimecalculations "Calendar calculations" section.
IsValid()
GetTicks()
GetCentury()
GetYear()
GetMonth()
GetDay()
GetWeekDay()
GetHour()
GetMinute()
GetSecond()
GetMillisecond()
GetDayOfYear()
GetWeekOfYear()
GetWeekOfMonth()
GetYearDay()
IsWorkDay()
IsGregorianDate()
GetAsDOS()
*/
@@ -88,17 +88,17 @@ public:
@ref getmodifiedjuliandaynumber() MJD or
@ref getratadie() "Rata Die number" from it.
@ref wxdatetimejdn() "wxDateTime(double jdn)"
@ref setjdn() "Set(double jdn)"
GetJulianDayNumber()
GetJDN()
GetModifiedJulianDayNumber()
GetMJD()
GetRataDie()
*/
@@ -110,33 +110,33 @@ public:
All (non-const) functions in this section don't modify the time part of the
wxDateTime -- they only work with the date part of it.
SetToWeekDayInSameWeek()
GetWeekDayInSameWeek()
SetToNextWeekDay()
GetNextWeekDay()
SetToPrevWeekDay()
GetPrevWeekDay()
SetToWeekDay()
@ref wxDateTime::getweekday2 GetWeekDay
SetToLastWeekDay()
GetLastWeekDay()
SetToWeekOfYear()
SetToLastMonthDay()
GetLastMonthDay()
SetToYearDay()
GetYearDay()
*/
@@ -147,49 +147,49 @@ public:
should use IsValid() method to check that the
values were correct as constructors can not return an error code.
@ref wxdatetimedef() wxDateTime
@ref wxdatetimetimet() wxDateTime(time_t)
@ref wxdatetimetm() "wxDateTime(struct tm)"
@ref wxdatetimejdn() "wxDateTime(double jdn)"
@ref wxdatetimetime() "wxDateTime(h, m, s, ms)"
@ref wxdatetimedate() "wxDateTime(day, mon, year, h, m, s, ms)"
SetToCurrent()
@ref settimet() Set(time_t)
@ref settm() "Set(struct tm)"
@ref setjdn() "Set(double jdn)"
@ref settime() "Set(h, m, s, ms)"
@ref setdate() "Set(day, mon, year, h, m, s, ms)"
@ref setfromdos() "SetFromDOS(unsigned long ddt)"
ResetTime()
SetYear()
SetMonth()
@ref setdate() SetDay
SetHour()
SetMinute()
SetSecond()
SetMillisecond()
@ref operatoreqtimet() operator=(time_t)
@ref operatoreqtm() "operator=(struct tm)"
*/
@@ -214,21 +214,21 @@ public:
modifies the object to which it is applied. The operators -= and += are
defined to be equivalent to the second forms of these functions.
@ref addts() Add(wxTimeSpan)
@ref addds() Add(wxDateSpan)
@ref subtractts() Subtract(wxTimeSpan)
@ref subtractds() Subtract(wxDateSpan)
@ref subtractdt() Subtract(wxDateTime)
@ref addts() oparator+=(wxTimeSpan)
@ref addds() oparator+=(wxDateSpan)
@ref subtractts() oparator-=(wxTimeSpan)
@ref subtractds() oparator-=(wxDateSpan)
*/
@@ -237,19 +237,19 @@ public:
There are several function to allow date comparison. To supplement them, a few
global operators , etc taking wxDateTime are defined.
IsEqualTo()
IsEarlierThan()
IsLaterThan()
IsStrictlyBetween()
IsBetween()
IsSameDate()
IsSameTime()
IsEqualUpTo()
*/
@@ -260,7 +260,7 @@ public:
It also accepts a few wxWidgets-specific extensions: you can optionally specify
the width of the field to follow using @c printf(3)-like syntax and the
format specification @c %l can be used to get the number of milliseconds.
@see ParseFormat()
*/
wxString Format(const wxChar* format = wxDefaultDateTimeFormat,
@@ -278,7 +278,7 @@ public:
result exactly corresponding to the ISO standard, but it can also be useful to
use a space as seprator if a more human-readable combined date-time
representation is needed.
@see FormatISODate(), FormatISOTime(),
ParseISOCombined()
*/
@@ -328,7 +328,7 @@ public:
Get the beginning of DST for the given country in the given year (current one
by default). This function suffers from limitations described in
@ref overview_tdatedst "DST overview".
@see GetEndDST()
*/
static wxDateTime GetBeginDST(int year = Inv_Year,
@@ -342,7 +342,7 @@ public:
/**
Returns the current default country. The default country is used for DST
calculations, for example.
@see SetCountry()
*/
static Country GetCountry();
@@ -360,9 +360,9 @@ public:
/**
Returns the object having the same date component as this one but time of
00:00:00.
@wxsince{2.8.2}
@see ResetTime()
*/
wxDateTime GetDateOnly() const;
@@ -381,7 +381,7 @@ public:
/**
Returns the end of DST for the given country in the given year (current one by
default).
@see GetBeginDST()
*/
static wxDateTime GetEndDST(int year = Inv_Year,
@@ -400,7 +400,7 @@ public:
/**
Returns the @ref setjdn() JDN corresponding to this date. Beware
of rounding errors!
@see GetModifiedJulianDayNumber()
*/
double GetJulianDayNumber() const;
@@ -451,7 +451,7 @@ public:
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
given month.
@see GetWeekDayName()
*/
static wxString GetMonthName(Month month,
@@ -540,7 +540,7 @@ public:
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
given week day.
@see GetMonthName()
*/
static wxString GetWeekDayName(WeekDay weekday,
@@ -584,7 +584,7 @@ public:
/**
Returns @true if IsStrictlyBetween()
is @true or if the date is equal to one of the limit values.
@see IsStrictlyBetween()
*/
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
@@ -649,7 +649,7 @@ public:
/**
Returns @true if this date lies strictly between the two others,
@see IsBetween()
*/
bool IsStrictlyBetween(const wxDateTime& t1,
@@ -695,11 +695,11 @@ public:
/**
Returns the object corresponding to the current time.
Example:
Note that this function is accurate up to second:
UNow() should be used for better precision
(but it is less efficient and might not be available on all platforms).
@see Today()
*/
static wxDateTime Now();
@@ -861,31 +861,31 @@ public:
additional argument of wxString::const_iterator type in which, if it is not
@NULL, an iterator pointing to the end of the scanned string part is returned.
ParseFormat()
ParseDateTime()
ParseDate()
ParseTime()
ParseISODate()
ParseISOTime()
ParseISOCombined()
wxDateTime::ParseRfc822Date
Format()
FormatDate()
FormatTime()
FormatISOCombined()
FormatISODate()
FormatISOTime()
*/
@@ -910,7 +910,7 @@ public:
calculations, date formatting and other things.
The possible values for @a country parameter are enumerated in
@ref overview_wxdatetime "wxDateTime constants section".
@see GetCountry()
*/
static void SetCountry(Country country);
@@ -1046,43 +1046,43 @@ public:
Please note that although several function accept an extra @e Calendar
parameter, it is currently ignored as only the Gregorian calendar is
supported. Future versions will support other calendars.
SetCountry()
GetCountry()
IsWestEuropeanCountry()
GetCurrentYear()
ConvertYearToBC()
GetCurrentMonth()
IsLeapYear()
@ref getcenturystatic() GetCentury
GetNumberOfDays()
GetNumberOfDays()
GetMonthName()
GetWeekDayName()
GetAmPmStrings()
IsDSTApplicable()
GetBeginDST()
GetEndDST()
Now()
UNow()
Today()
*/
@@ -1097,21 +1097,21 @@ public:
Please see the @ref overview_tdatetimezones "time zone overview" for more
information about time zones. Normally, these functions should be rarely used.
FromTimezone()
ToTimezone()
MakeTimezone()
MakeFromTimezone()
ToUTC()
MakeUTC()
GetBeginDST()
GetEndDST()
IsDST()
*/
@@ -1132,7 +1132,7 @@ public:
/**
Returns the object corresponding to the midnight of the current day (i.e. the
same as Now(), but the time part is set to 0).
@see Now()
*/
static wxDateTime Today();
@@ -1141,7 +1141,7 @@ public:
Returns the object corresponding to the current time including the
milliseconds if a function to get time with such precision is available on the
current platform (supported under most Unices and Win32).
@see Now()
*/
static wxDateTime UNow();
@@ -1236,14 +1236,14 @@ public:
/**
Returns a date span object corresponding to one day.
@see Days()
*/
static wxDateSpan Day();
/**
Returns a date span object corresponding to the given number of days.
@see Day()
*/
static wxDateSpan Days(int days);
@@ -1251,7 +1251,7 @@ public:
/**
Returns the number of days (only, that it not counting the weeks component!)
in this date span.
@see GetTotalDays()
*/
int GetDays() const;
@@ -1264,14 +1264,14 @@ public:
/**
Returns the combined number of days in this date span, counting both weeks and
days. It still doesn't take neither months nor years into the account.
@see GetWeeks(), GetDays()
*/
int GetTotalDays() const;
/**
Returns the number of weeks in this date span.
@see GetTotalDays()
*/
int GetWeeks() const;
@@ -1283,14 +1283,14 @@ public:
/**
Returns a date span object corresponding to one month.
@see Months()
*/
static wxDateSpan Month();
/**
Returns a date span object corresponding to the given number of months.
@see Month()
*/
static wxDateSpan Months(int mon);
@@ -1310,7 +1310,7 @@ public:
//@{
/**
Changes the sign of this date span.
@see Negate()
*/
wxDateSpan Neg();
@@ -1319,7 +1319,7 @@ public:
/**
Returns the date span with the opposite sign.
@see Neg()
*/
wxDateSpan Negate() const;
@@ -1360,28 +1360,28 @@ public:
/**
Returns a date span object corresponding to one week.
@see Weeks()
*/
static wxDateSpan Week();
/**
Returns a date span object corresponding to the given number of weeks.
@see Week()
*/
static wxDateSpan Weeks(int weeks);
/**
Returns a date span object corresponding to one year.
@see Years()
*/
static wxDateSpan Year();
/**
Returns a date span object corresponding to the given number of years.
@see Year()
*/
static wxDateSpan Years(int years);
@@ -1433,15 +1433,15 @@ public:
/**
GetSeconds()
GetMinutes()
GetHours()
GetDays()
GetWeeks()
GetValue()
*/
@@ -1473,35 +1473,35 @@ public:
/**
Returns the string containing the formatted representation of the time span.
The following format specifiers are allowed after %:
H
number of @b Hours
M
number of @b Minutes
S
number of @b Seconds
l
number of mi@b lliseconds
D
number of @b Days
E
number of w@b Eeks
%
the percent character
Note that, for example, the number of hours in the description above is not
well defined: it can be either the total number of hours (for example, for a
time span of 50 hours this would be 50) or just the hour part of the time
@@ -1643,15 +1643,15 @@ public:
/**
Add()
Subtract()
Multiply()
Negate()
Neg()
Abs()
*/
@@ -1668,27 +1668,27 @@ public:
/**
Milliseconds()
Millisecond()
Seconds()
Second()
Minutes()
Minute()
Hours()
Hour()
Days()
Day()
Weeks()
Week()
*/
@@ -1704,15 +1704,15 @@ public:
/**
IsNull()
IsPositive()
IsNegative()
IsEqualTo()
IsLongerThan()
IsShorterThan()
*/

4
interface/datstrm.h
View File

@@ -34,7 +34,7 @@ public:
)
Constructs a datastream object from an output stream. Only write methods will
be available. The second form is only available in Unicode build of wxWidgets.
@param stream
The output stream.
@param conv
@@ -169,7 +169,7 @@ public:
)
Constructs a datastream object from an input stream. Only read methods will
be available. The second form is only available in Unicode build of wxWidgets.
@param stream
The input stream.
@param conv

86
interface/dc.h
View File

@@ -39,7 +39,7 @@ public:
Copy from a source DC to this DC, specifying the destination
coordinates, size of area to copy, source DC, source coordinates,
logical function, whether to use a bitmap mask, and mask source position.
@param xdest
Destination device context x position.
@param ydest
@@ -61,8 +61,8 @@ public:
with the bitmap
selected into the source device context. The Windows implementation does
the following if MaskBlt cannot be used:
Creates a temporary bitmap and copies the destination area into it.
Copies the source area into the temporary bitmap using the specified
logical function.
@@ -75,8 +75,8 @@ public:
and the background colour set to WHITE.
ORs the temporary bitmap with the destination area.
Deletes the temporary bitmap.
This sequence of operations ensures that the source's transparent area need
not be black,
and logical functions are supported.
@@ -97,9 +97,9 @@ public:
and ysrc
will be assumed for the mask source position. Currently only implemented on
Windows.
@remarks There is partial support for Blit in wxPostScriptDC, under X.
@see StretchBlit(), wxMemoryDC, wxBitmap, wxMask
*/
bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width,
@@ -114,7 +114,7 @@ public:
Adds the specified point to the bounding box which can be retrieved with
MinX(), MaxX() and
MinY(), MaxY() functions.
@see ResetBoundingBox()
*/
void CalcBoundingBox(wxCoord x, wxCoord y);
@@ -207,7 +207,7 @@ public:
//@{
/**
Draws a circle with the given centre and radius.
@see DrawEllipse()
*/
void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
@@ -219,7 +219,7 @@ public:
Draws an ellipse contained in the rectangle specified either with the given top
left corner and the given size or directly. The current pen is used for the
outline and the current brush for filling the shape.
@see DrawCircle()
*/
void DrawEllipse(wxCoord x, wxCoord y, wxCoord width,
@@ -358,7 +358,7 @@ public:
particular, a font different from @c wxNORMAL_FONT should be used as the
latter is not a TrueType font. @c wxSWISS_FONT is an example of a font
which is.
@see DrawText()
*/
void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
@@ -438,7 +438,7 @@ public:
/**
Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
@see SetBackgroundMode()
*/
int GetBackgroundMode() const;
@@ -466,7 +466,7 @@ public:
/**
Returns the depth (number of bits/pixel) of this DC.
@see wxDisplayDepth()
*/
int GetDepth() const;
@@ -485,7 +485,7 @@ public:
is supported, the return value will either be @c wxLayout_LeftToRight or
@c wxLayout_RightToLeft. If RTL layout is not supported, the return value will
be @c wxLayout_Default.
@see SetLayoutDirection()
*/
wxLayoutDirection GetLayoutDirection() const;
@@ -510,7 +510,7 @@ public:
If the optional parameter @a font is specified and valid, then it is used
for the text extent calculation. Otherwise the currently selected font is.
Note that this function works both with single-line and multi-line strings.
@see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent()
*/
void GetMultiLineTextExtent(const wxString& string, wxCoord* w,
@@ -533,7 +533,7 @@ public:
various platforms have a native API function that is faster or more
accurate than the generic implementation then it should be used
instead.
@see GetMultiLineTextExtent(), GetTextExtent()
*/
bool GetPartialTextExtents(const wxString& text,
@@ -559,14 +559,14 @@ public:
represent the maximum horizontal and vertical 'pixel' values used in your
application, the following code will scale the graphic to fit on the
printer page:
@b GetSize()
Returns a Wx::Size
@b GetSizeWH()
Returns a 2-element list
@c ( width, height )
*/
@@ -599,7 +599,7 @@ public:
If the optional parameter @a font is specified and valid, then it is used
for the text extent calculation. Otherwise the currently selected font is.
Note that this function only works with single-line strings.
@see wxFont, SetFont(), GetPartialTextExtents(),
GetMultiLineTextExtent()
*/
@@ -707,7 +707,7 @@ public:
/**
Resets the bounding box: after a call to this function, the bounding box
doesn't contain anything.
@see CalcBoundingBox()
*/
void ResetBoundingBox();
@@ -716,7 +716,7 @@ public:
Sets the x and y axis orientation (i.e., the direction from lowest to
highest values on the axis). The default orientation is
x axis from left to right and y axis from top down.
@param xLeftRight
True to set the x axis orientation to the natural
left to right orientation, @false to invert it.
@@ -758,7 +758,7 @@ public:
The clipping region is an area to which drawing is restricted. Possible uses
for the clipping region are for clipping text or for speeding up window redraws
when only a known area of the screen is damaged.
@see DestroyClippingRegion(), wxRegion
*/
void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
@@ -786,7 +786,7 @@ public:
/**
Sets the current layout direction for the device context. @a dir may be either
@c wxLayout_Default, @c wxLayout_LeftToRight or @c wxLayout_RightToLeft.
@see GetLayoutDirection()
*/
void SetLayoutDirection(wxLayoutDirection dir);
@@ -799,7 +799,7 @@ public:
The possible values
and their meaning in terms of source and destination pixel values are
as follows:
The default is wxCOPY, which simply draws with the current colour.
The others combine the current colour and the background using a
logical operation. wxINVERT is commonly used for drawing rubber bands or
@@ -819,26 +819,26 @@ public:
Drawing to a Windows printer device context uses the current mapping mode,
but mapping mode is currently ignored for PostScript output.
The mapping mode can be one of the following:
wxMM_TWIPS
Each logical unit is 1/20 of a point, or 1/1440 of
an inch.
wxMM_POINTS
Each logical unit is a point, or 1/72 of an inch.
wxMM_METRIC
Each logical unit is 1 mm.
wxMM_LOMETRIC
Each logical unit is 1/10 of a mm.
wxMM_TEXT
Each logical unit is 1 device pixel.
*/
void SetMapMode(int int);
@@ -896,7 +896,7 @@ public:
coordinates, destination size, source DC, source coordinates,
size of source area to copy, logical function, whether to use a bitmap mask,
and mask source position.
@param xdest
Destination device context x position.
@param ydest
@@ -922,8 +922,8 @@ public:
with the bitmap
selected into the source device context. The Windows implementation does
the following if MaskBlt cannot be used:
Creates a temporary bitmap and copies the destination area into it.
Copies the source area into the temporary bitmap using the specified
logical function.
@@ -936,8 +936,8 @@ public:
and the background colour set to WHITE.
ORs the temporary bitmap with the destination area.
Deletes the temporary bitmap.
This sequence of operations ensures that the source's transparent area need
not be black,
and logical functions are supported.
@@ -958,7 +958,7 @@ public:
and ysrc
will be assumed for the mask source position. Currently only implemented on
Windows.
@remarks There is partial support for Blit in wxPostScriptDC, under X.
*/
bool StretchBlit(wxCoord xdest, wxCoord ydest, wxCoord dstWidth,

2
interface/dcbuffer.h
View File

@@ -49,7 +49,7 @@ public:
Init() methods later in order to use the object.
The other constructors initialize the object immediately and @c Init()
must not be called after using them.
@param dc
The underlying DC: everything drawn to this object will be
flushed to this DC when this object is destroyed. You may pass @NULL

2
interface/dcmemory.h
View File

@@ -47,7 +47,7 @@ public:
Also, before using the updated bitmap data, make sure to select it out of
context first
(for example by selecting wxNullBitmap into the device context).
@see wxDC::DrawBitmap
*/
void SelectObject(wxBitmap& bitmap);

2
interface/dcscreen.h
View File

@@ -53,7 +53,7 @@ public:
You might use this pair of functions when implementing a drag feature, for
example
as in the wxSplitterWindow implementation.
@remarks This function is probably obsolete since the X implementations
allow drawing directly on the screen now. However, the
fact that this function allows the screen to be

30
interface/dcsvg.h
View File

@@ -162,7 +162,7 @@ public:
//@{
/**
Draws a circle with the given centre and radius.
@see wxDC::DrawEllipse
*/
void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
@@ -174,7 +174,7 @@ public:
Draws an ellipse contained in the rectangle specified either with the given top
left corner and the given size or directly. The current pen is used for the
outline and the current brush for filling the shape.
@see wxDC::DrawCircle
*/
void DrawEllipse(wxCoord x, wxCoord y, wxCoord width,
@@ -339,7 +339,7 @@ public:
/**
Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
@see wxDC::SetBackgroundMode
*/
int GetBackgroundMode() const;
@@ -500,7 +500,7 @@ public:
/**
Resets the bounding box: after a call to this function, the bounding box
doesn't contain anything.
@see wxDC::CalcBoundingBox
*/
void ResetBoundingBox();
@@ -509,7 +509,7 @@ public:
Sets the x and y axis orientation (i.e., the direction from lowest to
highest values on the axis). The default orientation is the natural
orientation, e.g. x axis from left to right and y axis from bottom up.
@param xLeftRight
True to set the x axis orientation to the natural
left to right orientation, @false to invert it.
@@ -586,26 +586,26 @@ public:
uses the current mapping mode, but mapping mode is currently ignored for
PostScript output.
The mapping mode can be one of the following:
wxMM_TWIPS
Each logical unit is 1/20 of a point, or 1/1440 of
an inch.
wxMM_POINTS
Each logical unit is a point, or 1/72 of an inch.
wxMM_METRIC
Each logical unit is 1 mm.
wxMM_LOMETRIC
Each logical unit is 1/10 of a mm.
wxMM_TEXT
Each logical unit is 1 pixel.
*/
void SetMapMode(int int);

52
interface/dialog.h
View File

@@ -69,7 +69,7 @@ public:
//@{
/**
Constructor.
@param parent
Can be @NULL, a frame or another dialog box.
@param id
@@ -89,7 +89,7 @@ public:
Used to associate a name with the window,
allowing the application user to set Motif resource values for
individual dialog boxes.
@see Create()
*/
wxDialog();
@@ -125,7 +125,7 @@ public:
/**
Centres the dialog box on the display.
@param direction
May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
*/
@@ -200,10 +200,10 @@ public:
/**
Ends a modal dialog, passing a value to be returned from the ShowModal()
invocation.
@param retCode
The value that should be returned by ShowModal.
@see ShowModal(), GetReturnCode(), SetReturnCode()
*/
void EndModal(int retCode);
@@ -211,7 +211,7 @@ public:
/**
Gets the identifier of the button which works like standard OK button in this
dialog.
@see SetAffirmativeId()
*/
int GetAffirmativeId() const;
@@ -229,7 +229,7 @@ public:
/**
Gets the identifier of the button to map presses of @c ESC
button to.
@see SetEscapeId()
*/
int GetEscapeId() const;
@@ -276,10 +276,10 @@ public:
/**
Gets the return code for this window.
@remarks A return code is normally associated with a modal dialog, where
ShowModal() returns a code to the application.
@see SetReturnCode(), ShowModal(), EndModal()
*/
int GetReturnCode();
@@ -295,10 +295,10 @@ public:
/**
Iconizes or restores the dialog. Windows only.
@param iconize
If @true, iconizes the dialog box; if @false, shows and restores it.
@remarks Note that in Windows, iconization has no effect since dialog
boxes cannot be iconized. However, applications may
need to explicitly restore dialog boxes under Motif
@@ -310,7 +310,7 @@ public:
/**
Returns @true if the dialog box is iconized. Windows only.
@remarks Always returns @false under Windows since dialogs cannot be
iconized.
*/
@@ -339,10 +339,10 @@ public:
/**
The default handler for wxEVT_SYS_COLOUR_CHANGED.
@param event
The colour change event.
@remarks Changes the dialog's colour to conform to the current settings
(Windows only). Add an event table entry for your
dialog class if you wish the behaviour to be different
@@ -350,7 +350,7 @@ public:
you do override this function, call wxEvent::Skip to
propagate the notification to child windows and
controls.
@see wxSysColourChangedEvent
*/
void OnSysColourChanged(wxSysColourChangedEvent& event);
@@ -365,7 +365,7 @@ public:
the special OK button in the PocketPC title bar, an event with this id is
generated.
By default, the affirmative id is wxID_OK.
@see GetAffirmativeId(), SetEscapeId()
*/
void SetAffirmativeId(int id);
@@ -387,7 +387,7 @@ public:
/**
Sets the icon for this dialog.
@param icon
The icon to associate with this dialog.
*/
@@ -395,7 +395,7 @@ public:
/**
Sets the icons for this dialog.
@param icons
The icons to associate with this dialog.
*/
@@ -422,7 +422,7 @@ public:
/**
Sets the adaptation mode, overriding the global adaptation flag. @a mode may be
one of the following values:
See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
more on layout adaptation.
*/
@@ -443,7 +443,7 @@ public:
Allows the programmer to specify whether the dialog box is modal (Show() blocks
control
until the dialog is hidden) or modeless (control returns immediately).
@param flag
If @true, the dialog will be modal, otherwise it will be modeless.
*/
@@ -451,26 +451,26 @@ public:
/**
Sets the return code for this window.
@param retCode
The integer return code, usually a control identifier.
@remarks A return code is normally associated with a modal dialog, where
ShowModal() returns a code to the application.
The function EndModal() calls SetReturnCode.
@see GetReturnCode(), ShowModal(), EndModal()
*/
void SetReturnCode(int retCode);
/**
Hides or shows the dialog.
@param show
If @true, the dialog box is shown and brought to the front;
otherwise the box is hidden. If @false and the dialog is
modal, control is returned to the calling program.
@remarks The preferred way of dismissing a modal dialog is to use
EndModal().
*/
@@ -480,7 +480,7 @@ public:
Shows a modal dialog. Program flow does not return until the dialog has been
dismissed with
EndModal().
@returns The return value is the value set with SetReturnCode().
*/
int ShowModal();

6
interface/dialup.h
View File

@@ -43,7 +43,7 @@ public:
Cancel dialing the number initiated with Dial()
with async parameter equal to @true.
Note that this won't result in DISCONNECTED event being sent.
@see IsDialing()
*/
bool CancelDialing();
@@ -116,7 +116,7 @@ public:
/**
Returns @true if (async) dialing is in progress.
@see Dial()
*/
bool IsDialing() const;
@@ -149,7 +149,7 @@ public:
so, in general, the user should be allowed to override it. This function
allows to forcefully set the online status - whatever our internal
algorithm may think about it.
@see IsOnline()
*/
void SetOnlineStatus(bool isOnline = true);

2
interface/dirctrl.h
View File

@@ -26,7 +26,7 @@ public:
//@{
/**
Main constructor.
@param parent
Parent window.
@param id

2
interface/dirdlg.h
View File

@@ -37,7 +37,7 @@ public:
/**
Constructor. Use ShowModal() to show
the dialog.
@param parent
Parent window.
@param message

6
interface/display.h
View File

@@ -22,7 +22,7 @@ class wxDisplay
public:
/**
Constructor, setting up a wxDisplay instance with the specified display.
@param index
The index of the display to use. This must be non-negative
and lower than the value returned by GetCount().
@@ -77,7 +77,7 @@ public:
/**
Returns the index of the display on which the given point lies. Returns
@c wxNOT_FOUND if the point is not on any connected display.
@param pt
The point to locate.
*/
@@ -88,7 +88,7 @@ public:
If the window is on more than one display it gets the display that overlaps the
window the most.
Returns @c wxNOT_FOUND if the window is not on any connected display.
@param win
The window to locate.
*/

30
interface/dnd.h
View File

@@ -33,7 +33,7 @@ public:
/**
Override this function to receive dropped text.
@param x
The x coordinate of the mouse.
@param y
@@ -108,14 +108,14 @@ public:
/**
Called when the mouse is being dragged over the drop target. By default,
this calls functions return the suggested return value @e def.
@param x
The x coordinate of the mouse.
@param y
The y coordinate of the mouse.
@param def
Suggested value for return value. Determined by SHIFT or CONTROL key states.
@returns Returns the desired operation or wxDragNone. This is used for
optical feedback from the side of the drop source,
typically in form of changing the icon.
@@ -126,12 +126,12 @@ public:
/**
Called when the user drops a data object on the target. Return @false to veto
the operation.
@param x
The x coordinate of the mouse.
@param y
The y coordinate of the mouse.
@returns Return @true to accept the data, @false to veto the operation.
*/
virtual bool OnDrop(wxCoord x, wxCoord y);
@@ -139,7 +139,7 @@ public:
/**
Called when the mouse enters the drop target. By default, this calls
OnDragOver().
@param x
The x coordinate of the mouse.
@param y
@@ -147,7 +147,7 @@ public:
@param def
Suggested default for return value. Determined by SHIFT or CONTROL key
states.
@returns Returns the desired operation or wxDragNone. This is used for
optical feedback from the side of the drop source,
typically in form of changing the icon.
@@ -195,7 +195,7 @@ public:
between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types.
@param win
The window which initiates the drag and drop operation.
@param iconCopy
@@ -216,7 +216,7 @@ public:
//@}
/**
*/
~wxDropSource();
@@ -224,13 +224,13 @@ public:
Do it (call this in response to a mouse button press, for example). This starts
the drag-and-drop operation which will terminate when the user releases the
mouse.
@param flags
If wxDrag_AllowMove is included in the flags, data may
be moved and not only copied (default). If wxDrag_DefaultMove is
specified (which includes the previous flag), this is even the default
operation
@returns Returns the operation requested by the user, may be wxDragCopy,
wxDragMove, wxDragLink, wxDragCancel or wxDragNone if
an error occurred.
@@ -248,13 +248,13 @@ public:
in this function. It is called on each mouse move, so your implementation must
not be too
slow.
@param effect
The effect to implement. One of wxDragCopy, wxDragMove, wxDragLink and
wxDragNone.
@param scrolling
@true if the window is scrolling. MSW only.
@returns Return @false if you want default feedback, or @true if you
implement your own feedback. The return values is
ignored under GTK.
@@ -263,7 +263,7 @@ public:
/**
Set the icon to use for a certain drag result.
@param res
The drag result to set the icon for.
@param cursor
@@ -308,7 +308,7 @@ public:
/**
Override this function to receive dropped files.
@param x
The x coordinate of the mouse.
@param y

32
interface/docview.h
View File

@@ -52,23 +52,23 @@ public:
wxTEMPLATE_VISIBLE The template may be displayed to the user in dialogs.
wxTEMPLATE_INVISIBLE The template may not be displayed to the user in dialogs.
wxDEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
)
will construct document and view objects from the class information
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
)
will construct document and view objects from perl packages
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName )
@c Wx::DocTemplate::CreateDocument() and
@c Wx::DocTemplate::CreateView() must be overridden
*/
@@ -367,7 +367,7 @@ public:
/**
Loads the file history from a config object.
@see wxConfig()
*/
void FileHistoryLoad(wxConfigBase& config);
@@ -381,7 +381,7 @@ public:
/**
Saves the file history into a config object. This must be called
explicitly by the application.
@see wxConfig()
*/
void FileHistorySave(wxConfigBase& resourceFile);
@@ -533,7 +533,7 @@ public:
Returns a document template by asking the user (if there is more than one
template).
This function is used in CreateDocument().
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
@@ -542,7 +542,7 @@ public:
If more than one template is passed in in templates,
then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog.
Default is @false.
*/
wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
@@ -556,7 +556,7 @@ public:
The dialog normally will not appear because the array of templates only contains
those relevant to the document in question, and often there will only be one
such.
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
@@ -565,7 +565,7 @@ public:
If more than one template is passed in in templates,
then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog.
Default is @false.
*/
wxDocTemplate* SelectViewType(wxDocTemplate** templates,
@@ -1372,7 +1372,7 @@ public:
/**
Returns the list of menus that are managed by this file history object.
@see UseMenu()
*/
const wxList GetMenus() const;
@@ -1380,7 +1380,7 @@ public:
/**
Loads the file history from the given config object. This function should be
called explicitly by the application.
@see wxConfig()
*/
void Load(wxConfigBase& config);
@@ -1398,7 +1398,7 @@ public:
/**
Saves the file history into the given config object. This must be called
explicitly by the application.
@see wxConfig()
*/
void Save(wxConfigBase& config);

4
interface/dragimag.h
View File

@@ -54,7 +54,7 @@ public:
for
wxGenericDragImage, and can be used when the application
supplies DoDrawImage() and GetImageRect().
@param image
Icon or bitmap to be used as the drag image. The bitmap can
have a mask.
@@ -93,7 +93,7 @@ public:
and Move() to show the image on the screen.
Call EndDrag() when the drag has finished.
Note that this call automatically calls CaptureMouse.
@param hotspot
The location of the drag position relative to the upper-left corner
of the image.

88
interface/dynarray.h
View File

@@ -192,15 +192,15 @@ public:
/**
wxArray::Add
wxArray::AddAt
wxArray::Insert
wxArray::SetCount
WX_APPEND_ARRAY()
WX_PREPEND_ARRAY()
*/
@@ -230,9 +230,9 @@ public:
never use wxBaseArray anyhow it shouldn't be a problem) and that you should not
derive your own classes from the array classes.
@ref wxArray::ctordef "wxArray default constructor"
@ref wxArray::ctorcopy "wxArray copy constructors and assignment operators"
@ref wxArray::dtor ~wxArray
*/
@@ -349,25 +349,25 @@ public:
WX_DECLARE_OBJARRAY macros and must be fully declared before you use
WX_DEFINE_OBJARRAY macro.
WX_DEFINE_ARRAY()
WX_DEFINE_EXPORTED_ARRAY()
WX_DEFINE_USER_EXPORTED_ARRAY()
WX_DEFINE_SORTED_ARRAY()
WX_DEFINE_SORTED_EXPORTED_ARRAY()
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY()
WX_DECLARE_EXPORTED_OBJARRAY()
WX_DECLARE_USER_EXPORTED_OBJARRAY()
WX_DEFINE_OBJARRAY()
WX_DEFINE_EXPORTED_OBJARRAY()
WX_DEFINE_USER_EXPORTED_OBJARRAY()
To slightly complicate the matters even further, the operator - defined by
default for the array iterators by these macros only makes sense if the array
@@ -375,33 +375,33 @@ public:
provokes warnings from some compilers and to avoid them you should use the
@c _PTR versions of the macros above. For example, to define an array of
pointers to @c double you should use:
Note that the above macros are generally only useful for
wxObject types. There are separate macros for declaring an array of a simple
type,
such as an int.
The following simple types are supported:
int
long
size_t
double
To create an array of a simple type, simply append the type you want in CAPS to
the array definition.
For example, for an integer array, you'd use one of the following variants:
WX_DEFINE_ARRAY_INT()
WX_DEFINE_EXPORTED_ARRAY_INT()
WX_DEFINE_USER_EXPORTED_ARRAY_INT()
WX_DEFINE_SORTED_ARRAY_INT()
WX_DEFINE_SORTED_EXPORTED_ARRAY_INT()
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
*/
@@ -420,7 +420,7 @@ public:
going to put in the array and will prevent the array code from reallocating the
memory more times than needed.
wxArray::Alloc
wxArray::Shrink
*/
@@ -430,11 +430,11 @@ public:
retrieve them - possibly using just the C array indexing [] operator which
does exactly the same as wxArray::Item method.
wxArray::GetCount
wxArray::IsEmpty
wxArray::Item
wxArray::Last
*/
@@ -447,7 +447,7 @@ public:
Detach() if you don't want this to happen. On the
other hand, when an object is removed from a wxArray nothing happens - you
should delete it manually if required:
See also WX_CLEAR_ARRAY() macro which deletes all
elements of a wxArray (supposed to contain pointers).
*/
@@ -459,7 +459,7 @@ public:
Detach() if you don't want this to happen. On
the other hand, when an object is removed from a wxArray nothing happens -
you should delete it manually if required:
See also WX_CLEAR_ARRAY() macro which deletes all
elements of a wxArray (supposed to contain pointers).
*/
@@ -467,22 +467,22 @@ public:
/**
WX_CLEAR_ARRAY()
wxArray::Empty
wxArray::Clear
wxArray::RemoveAt
wxArray::Remove
*/
/**
wxArray::Index
wxArray::IndexForInsert
wxArray::Sort
*/
@@ -493,7 +493,7 @@ public:
@e count. If the array has already @a count or more items, nothing is
done. Otherwise, @c count - GetCount() elements are added and initialized to
the value @e defval.
@see wxArray::GetCount
*/
void SetCount(size_t count);
@@ -508,7 +508,7 @@ public:
/**
The notation CMPFUNCT should be read as if we had the following declaration:
where @e T is the type of the array elements. I.e. it is a function returning
@e int which is passed two arguments of type @e T *.
Sorts the array using the specified compare function: this function should
@@ -538,7 +538,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
You must use WX_DEFINE_OBJARRAY() macro to define
the array class - otherwise you would get link errors.
*/
@@ -554,7 +554,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
Note that wxWidgets predefines the following standard array classes: @b
wxArrayInt,
@b wxArrayLong, @b wxArrayShort, @b wxArrayDouble, @b wxArrayPtrVoid.
@@ -589,7 +589,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
You will have to initialize the objects of this class by passing a comparison
function to the array object constructor like this:
*/

60
interface/dynlib.h
View File

@@ -24,14 +24,14 @@ class wxDynamicLibraryDetails
public:
/**
Retrieves the load address and the size of this module.
@param addr
the pointer to the location to return load address in, may be
@NULL
@param len
pointer to the location to return the size of this module in
memory in, may be @NULL
@returns @true if the load address and module size were retrieved, @false
if this information is not available.
*/
@@ -150,7 +150,7 @@ public:
function name.
Returned value will be @NULL if the symbol was not found in the DLL or if
an error occurred.
@param dllHandle
Valid handle previously returned by
LoadLibrary
@@ -168,7 +168,7 @@ public:
Returns a handle to the loaded DLL. Use @a success parameter to test if it
is valid. If the handle is valid, the library must be unloaded later with
UnloadLibrary().
@param libname
Name of the shared object to load.
@param success
@@ -218,16 +218,16 @@ public:
it adds a @c ".dll" extension under Windows and @c "lib" prefix and
@c ".so", @c ".sl" or maybe @c ".dylib" extension under Unix.
The possible values for @a cat are:
wxDL_LIBRARY
normal library
wxDL_MODULE
a loadable module or plugin
@see CanonicalizePluginName()
*/
static wxString CanonicalizeName(const wxString& name,
@@ -240,14 +240,14 @@ public:
to the name to ensure that the plugin which is going to be loaded will be
compatible with the main program.
The possible values for @a cat are:
wxDL_PLUGIN_GUI
plugin which uses GUI classes (default)
wxDL_PLUGIN_BASE
plugin which only uses wxBase
*/
static wxString CanonicalizePluginName(const wxString& name,
@@ -269,7 +269,7 @@ public:
/**
Returns pointer to symbol @a name in the library or @NULL if the library
contains no such symbol.
@see wxDYNLIB_FUNCTION()
*/
void* GetSymbol(const wxString& name) const;
@@ -289,7 +289,7 @@ public:
Returns @true if the symbol with the given @a name is present in the dynamic
library, @false otherwise. Unlike GetSymbol(),
this function doesn't log an error message if the symbol is not found.
@wxsince{2.5.4}
*/
bool HasSymbol(const wxString& name) const;
@@ -312,33 +312,33 @@ public:
/**
Loads DLL with the given @a name into memory. The @a flags argument can
be a combination of the following bits:
wxDL_LAZY
equivalent of RTLD_LAZY under Unix, ignored elsewhere
wxDL_NOW
equivalent of RTLD_NOW under Unix, ignored elsewhere
wxDL_GLOBAL
equivalent of RTLD_GLOBAL under Unix, ignored elsewhere
wxDL_VERBATIM
don't try to append the appropriate extension to
the library name (this is done by default).
wxDL_DEFAULT
default flags, same as wxDL_NOW currently
wxDL_QUIET
don't log an error message if the library couldn't be
loaded.
Returns @true if the library was successfully loaded, @false otherwise.
*/
bool Load(const wxString& name, int flags = wxDL_DEFAULT);

4
interface/editlbox.h
View File

@@ -37,7 +37,7 @@ public:
//@{
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -54,7 +54,7 @@ public:
Window style. See wxEditableListBox.
@param name
Window name.
@see Create()
*/
wxEditableListBox();

12
interface/encconv.h
View File

@@ -75,7 +75,7 @@ public:
wxPLATFORM_CURRENT
wxPLATFORM_CURRENT means the platform this binary was compiled for.
Examples:
Equivalence is defined in terms of convertibility:
two encodings are equivalent if you can convert text between
then without losing information (it may - and will - happen
@@ -100,19 +100,19 @@ public:
it more than once in order to switch to another conversion.
@e Method affects behaviour of Convert() in case input character
cannot be converted because it does not exist in output encoding:
@b wxCONVERT_STRICT
follow behaviour of GNU Recode -
just copy unconvertible characters to output and don't change them
(its integer value will stay the same)
@b wxCONVERT_SUBSTITUTE
try some (lossy) substitutions
- e.g. replace unconvertible latin capitals with acute by ordinary
capitals, replace en-dash or em-dash by '-' etc.
Both modes guarantee that output string will have same length
as input string.
*/

136
interface/event.h
View File

@@ -121,12 +121,12 @@ public:
Notice that this function is easier to use correctly than, for example,
ControlDown() because when using the latter you
also have to remember to test that none of the other modifiers is pressed:
and forgetting to do it can result in serious program bugs (e.g. program not
working with European keyboard layout where ALTGR key which is seen by
the program as combination of CTRL and ALT is used). On the
other hand, you can simply write
with this function.
*/
int GetModifiers() const;
@@ -277,7 +277,7 @@ public:
/**
Returns @true if the event was a down event from the specified button (or any
button).
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@@ -286,7 +286,7 @@ public:
/**
Returns @true if the specified button (or any button) was in a down state.
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@@ -296,7 +296,7 @@ public:
/**
Returns @true if the event was an up event from the specified button (or any
button).
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@@ -523,7 +523,7 @@ public:
the interval is set to 0; so update events will be sent as
often as possible. You can reduce the frequency that events
are sent by changing the mode and/or setting an update interval.
@see ResetUpdateTime(), SetUpdateInterval(),
SetMode()
*/
@@ -604,7 +604,7 @@ public:
current time. It is assumed that update events are
normally sent in idle time, so this is called at the end of
idle processing.
@see CanUpdate(), SetUpdateInterval(),
SetMode()
*/
@@ -748,7 +748,7 @@ class wxMouseEvent : public wxEvent
public:
/**
Constructor. Valid event types are:
@b wxEVT_ENTER_WINDOW
@b wxEVT_LEAVE_WINDOW
@b wxEVT_LEFT_DOWN
@@ -823,29 +823,29 @@ public:
/**
Returns @true if the identified mouse button is changing state. Valid
values of @a button are:
@c wxMOUSE_BTN_LEFT
check if left button was pressed
@c wxMOUSE_BTN_MIDDLE
check if middle button was pressed
@c wxMOUSE_BTN_RIGHT
check if right button was pressed
@c wxMOUSE_BTN_AUX1
check if the first extra button was pressed
@c wxMOUSE_BTN_AUX2
check if the second extra button was pressed
@c wxMOUSE_BTN_ANY
check if any button was pressed
*/
bool Button(int button);
@@ -877,7 +877,7 @@ public:
/**
Same as MetaDown() under Mac, same as
ControlDown() elsewhere.
@see wxKeyEvent::CmdDown
*/
bool CmdDown() const;
@@ -889,7 +889,7 @@ public:
/**
Returns @true if this was a dragging event (motion while a button is depressed).
@see Moving()
*/
bool Dragging();
@@ -915,7 +915,7 @@ public:
Currently this function is implemented only in wxMac and returns -1 for the
other platforms (you can still distinguish simple clicks from double-clicks as
they generate different kinds of events however).
@wxsince{2.9.0}
*/
int GetClickCount() const;
@@ -1512,7 +1512,7 @@ class wxChildFocusEvent : public wxCommandEvent
public:
/**
Constructor.
@param win
The direct child which is (or which contains the window which is) receiving
the focus.
@@ -1650,25 +1650,25 @@ public:
/**
Returns the origin of the help event which is one of the following values:
@b Origin_Unknown
Unrecognized event source.
@b Origin_Keyboard
Event generated by @c F1 key press.
@b Origin_HelpButton
Event generated by
wxContextHelp or using the "?" title bur button under
MS Windows.
The application may handle events generated using the keyboard or mouse
differently, e.g. by using wxGetMousePosition()
for the mouse events.
@see SetOrigin()
*/
wxHelpEvent::Origin GetOrigin() const;
@@ -1681,7 +1681,7 @@ public:
/**
Set the help event origin, only used internally by wxWidgets normally.
@see GetOrigin()
*/
void SetOrigin(wxHelpEvent::Origin origin);
@@ -1780,7 +1780,7 @@ public:
the update mode is initially wxIDLE_PROCESS_ALL. You can change the mode
to only send idle events to windows with the wxWS_EX_PROCESS_IDLE extra window
style set.
@see SetMode()
*/
static bool CanSend(wxWindow* window);
@@ -1796,7 +1796,7 @@ public:
/**
Returns @true if the OnIdle function processing this event requested more
processing time.
@see RequestMore()
*/
bool MoreRequested() const;
@@ -1811,7 +1811,7 @@ public:
during OnIdle, then the application will remain in a passive event loop (not
calling OnIdle) until a
new event is posted to the application by the windowing system.
@see MoreRequested()
*/
void RequestMore(bool needMore = true);
@@ -2221,10 +2221,10 @@ public:
/**
This function posts an event to be processed later.
@param event
Event to add to process queue.
@remarks The difference between sending an event (using the ProcessEvent
method) and posting it is that in the first case the
event is processed before the function returns, while
@@ -2240,7 +2240,7 @@ public:
type. This
is an alternative to the use of static event tables. See the 'event' or the old
'dynamic' sample for usage.
@param id
The identifier (or first of the identifier range) to be
associated with the event handler function. For the version not taking this
@@ -2283,7 +2283,7 @@ public:
added
using the Connect() method. There is no way
to disconnect functions connected using the (static) event tables.
@param id
The identifier (or first of the identifier range) associated with the event
handler function.
@@ -2317,32 +2317,32 @@ public:
/**
Gets user-supplied client data.
@remarks Normally, any extra data the programmer wishes to associate with
the object should be made available by deriving a new
class with new data members.
@see SetClientData()
*/
void* GetClientData();
/**
Get a pointer to the user-supplied client data object.
@see SetClientObject(), wxClientData
*/
wxClientData* GetClientObject() const;
/**
Returns @true if the event handler is enabled, @false otherwise.
@see SetEvtHandlerEnabled()
*/
bool GetEvtHandlerEnabled();
/**
Gets the pointer to the next handler in the chain.
@see SetNextHandler(), GetPreviousHandler(),
SetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2351,7 +2351,7 @@ public:
/**
Gets the pointer to the previous handler in the chain.
@see SetPreviousHandler(), GetNextHandler(),
SetNextHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2361,18 +2361,18 @@ public:
/**
Processes an event, searching event tables and calling zero or more suitable
event handler function(s).
@param event
Event to process.
@returns @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@remarks Normally, your application would not call this function: it is
called in the wxWidgets implementation to dispatch
incoming user interface events to the framework (and
application).
@see SearchEventTable()
*/
virtual bool ProcessEvent(wxEvent& event);
@@ -2382,13 +2382,13 @@ public:
and handles any exceptions that occur in the process. If an exception is
thrown in event handler, wxApp::OnExceptionInMainLoop
is called.
@param event
Event to process.
@returns @true if the event was processed, @false if no handler was found
or an exception was thrown.
@see wxWindow::HandleWindowEvent
*/
bool SafelyProcessEvent(wxEvent& event);
@@ -2397,18 +2397,18 @@ public:
Searches the event table, executing an event handler function if an appropriate
one
is found.
@param table
Event table to be searched.
@param event
Event to be matched against an event table entry.
@returns @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@remarks This function looks through the object's event table and tries
to find an entry that will match the event.
@see ProcessEvent()
*/
virtual bool SearchEventTable(wxEventTable& table,
@@ -2416,47 +2416,47 @@ public:
/**
Sets user-supplied client data.
@param data
Data to be associated with the event handler.
@remarks Normally, any extra data the programmer wishes to associate with
the object should be made available by deriving a new
class with new data members. You must not call this
method and SetClientObject on the same class - only one
of them.
@see GetClientData()
*/
void SetClientData(void* data);
/**
Set the client data object. Any previous object will be deleted.
@see GetClientObject(), wxClientData
*/
void SetClientObject(wxClientData* data);
/**
Enables or disables the event handler.
@param enabled
@true if the event handler is to be enabled, @false if it is to be disabled.
@remarks You can use this function to avoid having to remove the event
handler from the chain, for example when implementing a
dialog editor and changing from edit to test mode.
@see GetEvtHandlerEnabled()
*/
void SetEvtHandlerEnabled(bool enabled);
/**
Sets the pointer to the next handler.
@param handler
Event handler to be set as the next handler.
@see GetNextHandler(), SetPreviousHandler(),
GetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@@ -2465,7 +2465,7 @@ public:
/**
Sets the pointer to the previous handler.
@param handler
Event handler to be set as the previous handler.
*/
@@ -2767,7 +2767,7 @@ public:
/**
Returns @true if the cursor specified by this event is a valid cursor.
@remarks You cannot specify wxNullCursor with this event, as it is not
considered a valid cursor.
*/

20
interface/ffile.h
View File

@@ -27,7 +27,7 @@ public:
//@{
/**
Opens a file with the given file pointer, which has already been opened.
@param filename
The filename.
@param mode
@@ -77,7 +77,7 @@ public:
read.
Also note that this method may only be called for opened files and may crash if
the file is not opened.
@see IsOpened()
*/
bool Eof() const;
@@ -87,7 +87,7 @@ public:
@c ferror() function.
Please note that this method may only be called for opened files and may crash
if the file is not opened.
@see IsOpened()
*/
@@ -116,7 +116,7 @@ public:
/**
Opens the file, returning @true if successful.
@param filename
The filename.
@param mode
@@ -127,12 +127,12 @@ public:
/**
Reads the specified number of bytes into a buffer, returning the actual number
read.
@param buffer
A buffer to receive the data.
@param count
The number of bytes to read.
@returns The number of bytes read.
*/
size_t Read(void* buffer, size_t count);
@@ -140,20 +140,20 @@ public:
/**
)
Reads the entire contents of the file into a string.
@param str
String to read data into.
@param conv
Conversion object to use in Unicode build; by default supposes
that file contents is encoded in UTF-8.
@returns @true if file was read successfully, @false otherwise.
*/
bool ReadAll(wxString* str);
/**
Seeks to the specified position and returns @true on success.
@param ofs
Offset to seek to.
@param mode
@@ -165,7 +165,7 @@ public:
Moves the file pointer to the specified number of bytes before the end of the
file
and returns @true on success.
@param ofs
Number of bytes before the end of the file.
*/

12
interface/file.h
View File

@@ -147,7 +147,7 @@ public:
/**
Associates the file with the given file descriptor, which has already been
opened.
@param filename
The filename.
@param mode
@@ -254,7 +254,7 @@ public:
/**
Opens the file, returning @true if successful.
@param filename
The filename.
@param mode
@@ -275,12 +275,12 @@ public:
/**
Seeks to the specified position.
@param ofs
Offset to seek to.
@param mode
One of wxFromStart, wxFromEnd, wxFromCurrent.
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/
@@ -291,10 +291,10 @@ public:
Moves the file pointer to the specified number of bytes relative to the end of
the file. For example, @c SeekEnd(-5) would position the pointer 5
bytes before the end.
@param ofs
Number of bytes before the end of the file.
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/

6
interface/fileconf.h
View File

@@ -32,7 +32,7 @@ public:
)
Read the config data from the specified stream instead of the associated file,
as usual.
@see Save()
*/
wxFileConfig(wxInputStream& is);
@@ -67,7 +67,7 @@ public:
after saving it successfully, the dirty flag is reset so no changes will be
written back to the file this object is associated with until you change its
contents again.
@see wxConfigBase::Flush
*/
bool Save(wxOutputStream& os);
@@ -78,7 +78,7 @@ public:
some sensitive information, such as passwords), you could use
@c SetUmask(0077).
This function doesn't do anything on non-Unix platforms.
@see wxCHANGE_UMASK()
*/
void SetUmask(int mode);

10
interface/filectrl.h
View File

@@ -61,7 +61,7 @@ public:
Initial size.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@@ -106,7 +106,7 @@ public:
function should only be used with the controls having the @c wxFC_MULTIPLE
style,
use GetFilename() for the others.
@remarks filenames is emptied first.
*/
void GetFilenames(wxArrayString& filenames) const;
@@ -127,7 +127,7 @@ public:
Fills the array @a paths with the full paths of the files chosen. This
function should be used with the controls having the @c wxFC_MULTIPLE style,
use GetPath() otherwise.
@remarks paths is emptied first.
*/
void GetPaths(wxArrayString& paths) const;
@@ -139,14 +139,14 @@ public:
/**
Sets(changes) the current directory displayed in the control.
@returns Returns @true on success, @false otherwise.
*/
bool SetDirectory(const wxString& directory);
/**
Selects a certain file.
@returns Returns @true on success, @false otherwise
*/
bool SetFilename(const wxString& filename);

2
interface/filedlg.h
View File

@@ -49,7 +49,7 @@ class wxFileDialog : public wxDialog
public:
/**
Constructor. Use ShowModal() to show the dialog.
@param parent
Parent window.
@param message

262
interface/filename.h
View File

@@ -120,7 +120,7 @@ public:
/**
Makes this object refer to the current working directory on the specified
volume (or current volume if @a volume is empty).
@see GetCwd()
*/
static void AssignCwd(const wxString& volume = wxEmptyString);
@@ -154,7 +154,7 @@ public:
/**
Removes the extension from the file name resulting in a
file name with no trailing dot.
@see SetExt(), SetEmptyExt()
*/
void SetClearExt();
@@ -172,12 +172,12 @@ public:
If @a fileTemp is @NULL, the file is only created, but not opened.
Under Unix, the temporary file will have read and write permissions for the
owner only to minimize the security problems.
@param prefix
Prefix to use for the temporary file name construction
@param fileTemp
The file to open or @NULL to just get the name
@returns The full temporary file name or an empty string on error.
*/
static wxString CreateTempFileName(const wxString& prefix,
@@ -202,37 +202,37 @@ public:
These functions allow to examine and modify the individual directories of the
path:
AppendDir()
InsertDir()
GetDirCount()
PrependDir()
RemoveDir()
RemoveLastDir()
To change the components of the file name individually you can use the
following functions:
GetExt()
GetName()
GetVolume()
HasExt()
HasName()
HasVolume()
SetExt()
ClearExt()
SetEmptyExt()
SetName()
SetVolume()
*/
@@ -240,21 +240,21 @@ public:
/**
You can initialize a wxFileName instance using one of the following functions:
@ref wxfilename() "wxFileName constructors"
Assign()
AssignCwd()
AssignDir()
AssignHomeDir()
@ref assigntempfilename() AssignHomeTempFileName
DirName()
FileName()
@ref operatorassign() "operator ="
*/
@@ -300,13 +300,13 @@ public:
or @ref operatorequal() "operator ==".
For testing basic access modes, you can use:
IsDirWritable()
IsDirReadable()
IsFileWritable()
IsFileReadable()
IsFileExecutable()
*/
@@ -314,7 +314,7 @@ public:
//@{
/**
Returns @true if the file with this name exists.
@see DirExists()
*/
bool FileExists();
@@ -332,10 +332,10 @@ public:
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.
@returns The string containing the current working directory or an empty
string on error.
@see AssignCwd()
*/
static wxString GetCwd(const wxString& volume = "");
@@ -414,7 +414,7 @@ public:
/**
Returns the name part of the filename (without extension).
@see GetFullName()
*/
wxString GetName() const;
@@ -422,15 +422,15 @@ public:
/**
Returns the path part of the filename (without the name or extension). The
possible flags values are:
@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
Return the path with the trailing
separator, if this flag is not given there will be no separator at the end of
the path.
@@ -443,7 +443,7 @@ public:
@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);
@@ -453,7 +453,7 @@ public:
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);
@@ -510,7 +510,7 @@ public:
file specified by GetFullPath().
Any of the pointers may be @NULL if the corresponding time is not
needed.
@returns @true on success, @false if we failed to retrieve the times.
*/
bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod,
@@ -662,7 +662,7 @@ public:
Make the file name absolute. This is a shortcut for
@c wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
wxPATH_NORM_TILDE, cwd, format).
@see MakeRelativeTo(), Normalize(), IsAbsolute()
*/
bool MakeAbsolute(const wxString& cwd = wxEmptyString,
@@ -670,22 +670,22 @@ public:
/**
This function tries to put this file name in a form relative to
@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
@param format
the file name format, native by default
@returns @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).
@see Normalize()
*/
bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
@@ -701,7 +701,7 @@ public:
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.
@returns Returns @true if the directory was successfully created, @false
otherwise.
*/
@@ -714,106 +714,106 @@ public:
Normalize the path. With the default flags value, the path will be
made absolute, without any ".." and "." and all environment
variables will be expanded in it.
@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
@param cwd
If not empty, this directory will be used instead of current
working directory in normalization (see wxPATH_NORM_ABSOLUTE).
@param format
The file name format to use when processing the paths, native by default.
@returns @true if normalization was successfully or @false otherwise.
*/
bool Normalize(int flags = wxPATH_NORM_ALL,
@@ -827,15 +827,15 @@ public:
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.
GetModificationTime()
GetTimes()
SetTimes()
Touch()
Other file system operations functions are:
Mkdir()
Rmdir()
*/
@@ -848,7 +848,7 @@ public:
/**
Removes the specified directory component from the path.
@see GetDirCount()
*/
void RemoveDir(size_t pos);
@@ -884,7 +884,7 @@ public:
Sets the extension of the file name to be an empty extension.
This is different from having no extension at all as the file
name will have a trailing dot after a call to this method.
@see SetExt(), ClearExt()
*/
void SetEmptyExt();
@@ -894,7 +894,7 @@ public:
as the extension will remove the extension resulting in a file
name without a trailing dot, unlike a call to
SetEmptyExt().
@see SetEmptyExt(), ClearExt()
*/
void SetExt(const wxString& ext);
@@ -906,7 +906,7 @@ public:
/**
Sets the name part (without extension).
@see SetFullName()
*/
void SetName(const wxString& name);
@@ -962,7 +962,7 @@ public:
/**
Splits the given @a fullpath into the volume part (which may be empty) and
the pure path part, not containing any volume.
@see SplitPath()
*/
static void SplitVolume(const wxString& fullpath,

4
interface/filepicker.h
View File

@@ -87,7 +87,7 @@ public:
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.
*/
@@ -201,7 +201,7 @@ public:
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.
*/

16
interface/filesys.h
View File

@@ -42,7 +42,7 @@ public:
@b Caution! Unless @a is_dir is @true the @a location parameter
is not the directory name but the name of the file in this directory. All these
commands change the path to "dir/subdir/":
@param location
the new location. Its meaning depends on the value of is_dir
@param is_dir
@@ -53,7 +53,7 @@ public:
/**
Converts filename into URL.
@see URLToFileName(), wxFileName
*/
static wxString FileNameToURL(wxFileName filename);
@@ -64,7 +64,7 @@ public:
@e path. If the file is found in any directory, returns @true and the full
path of the file in @e str, otherwise returns @false and doesn't modify
@e str.
@param str
Receives the full path of the file, must not be @NULL
@param path
@@ -107,7 +107,7 @@ public:
absolute path. Note that the user is responsible for deleting the returned
wxFSFile.
@a flags can be one or more of the following bit values ored together:
A stream opened with just the default @e wxFS_READ flag may
or may not be seekable depending on the underlying source.
Passing @e wxFS_READ | wxFS_SEEKABLE for @a flags will
@@ -150,7 +150,7 @@ class wxFSFile : public wxObject
public:
/**
Constructor. You probably won't use it. See Notes for details.
@param stream
The input stream that will be used to access data
@param location
@@ -177,7 +177,7 @@ public:
/**
Returns anchor (if present). The term of @b anchor can be easily
explained using few examples:
Usually an anchor is presented only if the MIME type is 'text/html'.
But it may have some meaning with other files;
for example myanim.avi#200 may refer to position in animation
@@ -253,7 +253,7 @@ public:
Returns @true if the handler is able to open this file. This function doesn't
check whether the file exists or not, it only checks if it knows the protocol.
Example:
Must be overridden in derived handlers.
*/
virtual bool CanOpen(const wxString& location);
@@ -313,7 +313,7 @@ public:
/**
Opens the file and returns wxFSFile pointer or @NULL if failed.
Must be overridden in derived handlers.
@param fs
Parent FS (the FS from that OpenFile was called). See ZIP handler
for details of how to use it.

554
interface/font.h
View File

@@ -41,7 +41,7 @@ public:
//@{
/**
Creates a font object with the specified attributes.
@param pointSize
Size in points.
@param pixelSize
@@ -53,123 +53,123 @@ public:
@param family
Font family, a generic way of referring to fonts without specifying actual
facename. One of:
wxFONTFAMILY_DEFAULT
Chooses a default font.
wxFONTFAMILY_DECORATIVE
A decorative font.
wxFONTFAMILY_ROMAN
A formal, serif font.
wxFONTFAMILY_SCRIPT
A handwriting font.
wxFONTFAMILY_SWISS
A sans-serif font.
wxFONTFAMILY_MODERN
A fixed pitch font.
wxFONTFAMILY_TELETYPE
A teletype font.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@param weight
Font weight, sometimes also referred to as font boldness. One of:
wxFONTWEIGHT_NORMAL
Normal font.
wxFONTWEIGHT_LIGHT
Light font.
wxFONTWEIGHT_BOLD
Bold font.
@param underline
The value can be @true or @false. At present this has an effect on Windows
@@ -180,75 +180,75 @@ public:
a default typeface will be chosen based on the family.
@param encoding
An encoding which may be one of
wxFONTENCODING_SYSTEM
Default system encoding.
wxFONTENCODING_DEFAULT
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.
wxFONTENCODING_ISO8859_1...15
ISO8859 encodings.
wxFONTENCODING_KOI8
The standard Russian encoding for Internet.
wxFONTENCODING_CP1250...1252
Windows encodings similar to ISO8859 (but not identical).
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.
@@ -271,7 +271,7 @@ public:
Destructor.
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
itself. This is because wxWidgets cannot know if a
@@ -282,7 +282,7 @@ public:
/**
Returns the current application's default encoding.
@see @ref overview_wxfontencodingoverview, SetDefaultEncoding()
*/
static wxFontEncoding GetDefaultEncoding();
@@ -291,7 +291,7 @@ public:
Returns the typeface name associated with the font, or the empty string if
there is no
typeface information.
@see SetFaceName()
*/
wxString GetFaceName() const;
@@ -299,7 +299,7 @@ public:
/**
Gets the font family. See SetFamily() for a list of valid
family identifiers.
@see SetFamily()
*/
wxFontFamily GetFamily() const;
@@ -310,7 +310,7 @@ public:
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.
@see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
*/
wxString GetNativeFontInfoDesc() const;
@@ -320,14 +320,14 @@ public:
non-empty.
Some examples of the formats of returned strings (which are platform-dependent)
are in SetNativeFontInfoUserDesc().
@see GetNativeFontInfoDesc()
*/
wxString GetNativeFontInfoUserDesc();
/**
Gets the point size.
@see SetPointSize()
*/
int GetPointSize() const;
@@ -335,14 +335,14 @@ public:
/**
Gets the font style. See wxFont() for a list of valid
styles.
@see SetStyle()
*/
int GetStyle() const;
/**
Returns @true if the font is underlined, @false otherwise.
@see SetUnderlined()
*/
bool GetUnderlined() const;
@@ -350,7 +350,7 @@ public:
/**
Gets the font weight. See wxFont() for a list of valid
weight identifiers.
@see SetWeight()
*/
wxFontWeight GetWeight() const;
@@ -398,7 +398,7 @@ public:
/**
Sets the default font encoding.
@see @ref overview_wxfontencodingoverview, GetDefaultEncoding()
*/
static void SetDefaultEncoding(wxFontEncoding encoding);
@@ -406,106 +406,106 @@ public:
/**
Sets the facename for the font.
Returns @true if the given face name exists; @false otherwise.
@param faceName
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.
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.
@see GetFaceName(), SetFamily()
*/
bool SetFaceName(const wxString& faceName);
/**
Sets the font family.
@param family
One of:
wxFONTFAMILY_DEFAULT
Chooses a default font.
wxFONTFAMILY_DECORATIVE
A decorative font.
wxFONTFAMILY_ROMAN
A formal, serif font.
wxFONTFAMILY_SCRIPT
A handwriting font.
wxFONTFAMILY_SWISS
A sans-serif font.
wxFONTFAMILY_MODERN
A fixed pitch font.
wxFONTFAMILY_TELETYPE
A teletype font.
@see GetFamily(), SetFaceName()
*/
void SetFamily(wxFontFamily family);
@@ -519,7 +519,7 @@ public:
invalid, font is unchanged. This function is typically used for de-serializing
a wxFont
object previously saved in a string-form.
@see SetNativeFontInfoUserDesc()
*/
bool SetNativeFontInfo(const wxString& info);
@@ -531,101 +531,101 @@ public:
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
on @b wxMSW: @c [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING]
Tahoma 10 WINDOWS-1252
on @b wxMac: FIXME
FIXME
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).
@see SetNativeFontInfo()
*/
bool SetNativeFontInfoUserDesc(const wxString& info);
/**
Sets the point size.
@param pointSize
Size in points.
@see GetPointSize()
*/
void SetPointSize(int pointSize);
/**
Sets the font style.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@see GetStyle()
*/
void SetStyle(int style);
/**
Sets underlining.
@param underlining
@true to underline, @false otherwise.
@see GetUnderlined()
*/
void SetUnderlined(const bool underlined);
/**
Sets the font weight.
@param weight
One of:
wxFONTWEIGHT_NORMAL
Normal font.
wxFONTWEIGHT_LIGHT
Light font.
wxFONTWEIGHT_BOLD
Bold font.
@see GetWeight()
*/
void SetWeight(wxFontWeight weight);

6
interface/fontmap.h
View File

@@ -63,7 +63,7 @@ public:
/**
Get the current font mapper object. If there is no current object, creates
one.
@see Set()
*/
static wxFontMapper* Get();
@@ -122,7 +122,7 @@ public:
/**
Return internal string identifier for the encoding (see also
wxFontMapper::GetEncodingDescription)
@see GetEncodingFromName()
*/
static wxString GetEncodingName(wxFontEncoding encoding);
@@ -145,7 +145,7 @@ public:
Set the current font mapper object and return previous one (may be @NULL).
This method is only useful if you want to plug-in an alternative font mapper
into wxWidgets.
@see Get()
*/
static wxFontMapper* Set(wxFontMapper* mapper);

2
interface/fontpicker.h
View File

@@ -75,7 +75,7 @@ public:
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.
*/

68
interface/frame.h
View File

@@ -90,7 +90,7 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent. This may be @NULL. If it is non-@NULL, the frame will
always be displayed on top of the parent window on Windows.
@@ -113,11 +113,11 @@ public:
item,
allowing the application user to set Motif resource values for
individual windows.
@remarks For Motif, MWM (the Motif Window Manager) should be running for
any window styles to work (otherwise all styles take
effect).
@see Create()
*/
wxFrame();
@@ -136,7 +136,7 @@ public:
/**
Centres the frame on the display.
@param direction
The parameter may be wxHORIZONTAL, wxVERTICAL or wxBOTH.
*/
@@ -155,7 +155,7 @@ public:
/**
Creates a status bar at the bottom of the frame.
@param number
The number of fields to create. Specify a
value greater than 1 to create a multi-field status bar.
@@ -167,14 +167,14 @@ public:
wxWidgets.
@param name
The status bar window name.
@returns A pointer to the status bar if it was created successfully, @NULL
otherwise.
@remarks The width of the status bar is the whole width of the frame
(adjusted automatically when resizing), and the height
and text size are chosen by the host windowing system.
@see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
*/
virtual wxStatusBar* CreateStatusBar(int number = 1,
@@ -184,7 +184,7 @@ public:
/**
Creates a toolbar at the top or left of the frame.
@param style
The toolbar style. See wxToolBar for a list
of valid styles.
@@ -193,15 +193,15 @@ public:
wxWidgets.
@param name
The toolbar window name.
@returns A pointer to the toolbar if it was created successfully, @NULL
otherwise.
@remarks By default, the toolbar is an instance of wxToolBar (which is
defined to be a suitable toolbar class on each
platform, such as wxToolBar95). To use a different
class, override OnCreateToolBar().
@see CreateStatusBar(), OnCreateToolBar(), SetToolBar(),
GetToolBar()
*/
@@ -217,7 +217,7 @@ public:
/**
Returns a pointer to the menubar currently associated with the frame (if any).
@see SetMenuBar(), wxMenuBar, wxMenu
*/
wxMenuBar* GetMenuBar() const;
@@ -225,28 +225,28 @@ public:
/**
Returns a pointer to the status bar currently associated with the frame (if
any).
@see CreateStatusBar(), wxStatusBar
*/
wxStatusBar* GetStatusBar() const;
/**
Returns the status bar pane used to display menu and toolbar help.
@see SetStatusBarPane()
*/
int GetStatusBarPane();
/**
Returns a pointer to the toolbar currently associated with the frame (if any).
@see CreateToolBar(), wxToolBar, SetToolBar()
*/
wxToolBar* GetToolBar() const;
/**
Virtual function called when a status bar is requested by CreateStatusBar().
@param number
The number of fields to create.
@param style
@@ -257,13 +257,13 @@ public:
wxWidgets.
@param name
The window name.
@returns A status bar object.
@remarks An application can override this function to return a different
kind of status bar. The default implementation returns
an instance of wxStatusBar.
@see CreateStatusBar(), wxStatusBar.
*/
virtual wxStatusBar* OnCreateStatusBar(int number, long style,
@@ -272,7 +272,7 @@ public:
/**
Virtual function called when a toolbar is requested by CreateToolBar().
@param style
The toolbar style. See wxToolBar for a list
of valid styles.
@@ -281,13 +281,13 @@ public:
wxWidgets.
@param name
The toolbar window name.
@returns A toolbar object.
@remarks An application can override this function to return a different
kind of toolbar. The default implementation returns an
instance of wxToolBar.
@see CreateToolBar(), wxToolBar.
*/
virtual wxToolBar* OnCreateToolBar(long style, wxWindowID id,
@@ -295,7 +295,7 @@ public:
/**
Simulate a menu command.
@param id
The identifier for a menu item.
*/
@@ -314,22 +314,22 @@ public:
/**
Tells the frame to show the given menu bar.
@param menuBar
The menu bar to associate with the frame.
@remarks If the frame is destroyed, the menu bar and its menus will be
destroyed also, so do not delete the menu bar
explicitly (except by resetting the frame's menu bar to
another frame or @NULL).
@see GetMenuBar(), wxMenuBar, wxMenu.
*/
void SetMenuBar(wxMenuBar* menuBar);
/**
Associates a status bar with the frame.
@see CreateStatusBar(), wxStatusBar, GetStatusBar()
*/
void SetStatusBar(wxStatusBar* statusBar);
@@ -342,21 +342,21 @@ public:
/**
Sets the status bar text and redraws the status bar.
@param text
The text for the status field.
@param number
The status field (starting from zero).
@remarks Use an empty string to clear the status bar.
@see CreateStatusBar(), wxStatusBar
*/
virtual void SetStatusText(const wxString& text, int number = 0);
/**
Sets the widths of the fields in the status bar.
@param n
The number of fields in the status bar. It must be the
same used in CreateStatusBar.
@@ -366,7 +366,7 @@ public:
least one
field must be -1. You should delete this array after calling
SetStatusWidths.
@remarks The widths of the variable fields are calculated from the total
width of all fields, minus the sum of widths of the
non-variable fields, divided by the number of variable

6
interface/fs_mem.h
View File

@@ -81,7 +81,7 @@ public:
Note that you must use a @a type value (aka image format)
that wxWidgets can save (e.g. JPG, PNG, see wxImage
documentation())!
@see AddFileWithMimeType()
*/
static void AddFile(const wxString& filename, wxImage& image,
@@ -96,9 +96,9 @@ public:
Like AddFile(), but lets you explicitly
specify added file's MIME type. This version should be used whenever you know
the MIME type, because it makes accessing the files faster.
@wxsince{2.8.5}
@see AddFile()
*/
static void AddFileWithMimeType(const wxString& filename,

28
interface/gauge.h
View File

@@ -48,7 +48,7 @@ public:
//@{
/**
Constructor, creating and showing a gauge.
@param parent
Window parent.
@param id
@@ -64,7 +64,7 @@ public:
Gauge style. See wxGauge.
@param name
Window name.
@see Create()
*/
wxGauge();
@@ -94,32 +94,32 @@ public:
/**
Returns the width of the 3D bezel face.
@remarks This method is not implemented (returns 0) for most platforms.
@see SetBezelFace()
*/
int GetBezelFace() const;
/**
Returns the maximum position of the gauge.
@see SetRange()
*/
int GetRange() const;
/**
Returns the 3D shadow margin width.
@remarks This method is not implemented (returns 0) for most platforms.
@see SetShadowWidth()
*/
int GetShadowWidth() const;
/**
Returns the current position of the gauge.
@see SetValue()
*/
int GetValue() const;
@@ -141,10 +141,10 @@ public:
/**
Sets the 3D bezel face width.
@remarks This method is not implemented (doesn't do anything) for most
platforms.
@see GetBezelFace()
*/
void SetBezelFace(int width);
@@ -152,14 +152,14 @@ public:
/**
Sets the range (maximum value) of the gauge.
This function makes the gauge switch to determinate mode, if it's not already.
@see GetRange()
*/
void SetRange(int range);
/**
Sets the 3D shadow width.
@remarks This method is not implemented (doesn't do anything) for most
platforms.
*/
@@ -170,10 +170,10 @@ public:
range as returned by GetRange(), inclusive.
This function makes the gauge switch to determinate mode, if it was in
indeterminate mode before.
@param pos
Position for the gauge level.
@see GetValue()
*/
void SetValue(int pos);

8
interface/glcanvas.h
View File

@@ -45,7 +45,7 @@ class wxGLContext : public wxObject
public:
/**
Constructor.
@param win
The canvas that is used to initialize this context. This parameter is
needed only temporarily,
@@ -121,9 +121,9 @@ public:
Creates a window with the given parameters. Notice that you need to create and
use a wxGLContext to output to this window.
If
@param attribList is not specified, double buffered RGBA mode is used.
parent
Pointer to a parent window.
@param id
@@ -165,7 +165,7 @@ public:
/**
Determines if a canvas having the specified attributes is available.
Returns @true if attributes are supported.
@param attribList
See attribList for wxGLCanvas().
*/

14
interface/graphics.h
View File

@@ -23,7 +23,7 @@ class wxGraphicsPath : public wxGraphicsObject
public:
//@{
/**
*/
void AddArc(wxDouble x, wxDouble y, wxDouble r,
wxDouble startAngle,
@@ -49,7 +49,7 @@ public:
//@{
/**
*/
void AddCurveToPoint(wxDouble cx1, wxDouble cy1, wxDouble cx2,
wxDouble cy2,
@@ -67,7 +67,7 @@ public:
//@{
/**
*/
void AddLineToPoint(wxDouble x, wxDouble y);
void AddLineToPoint(const wxPoint2DDouble& p);
@@ -220,7 +220,7 @@ public:
//@{
/**
Creates a wxGraphicsContext from a wxWindow.
@see wxGraphicsRenderer:: CreateContext
*/
wxGraphicsContext* Create(const wxWindowDC& dc);
@@ -242,9 +242,9 @@ public:
Creates a wxGraphicsContext from a native context. This native context must be
eg a CGContextRef for Core Graphics, a Graphics pointer for GDIPlus or a
cairo_t pointer for cairo.
Creates a wxGraphicsContext from a native window.
@see wxGraphicsRenderer:: CreateContextFromNativeContext
*/
wxGraphicsContext* CreateFromNative(void* context);
@@ -617,7 +617,7 @@ class wxGraphicsMatrix : public wxGraphicsObject
public:
//@{
/**
*/
void Concat(const wxGraphicsMatrix* t);
void Concat(const wxGraphicsMatrix& t);

296
interface/grid.h
View File

@@ -70,27 +70,27 @@ class wxGridTableBase : public wxObject
{
public:
/**
*/
wxGridTableBase();
/**
*/
~wxGridTableBase();
/**
*/
bool AppendCols(size_t numCols = 1);
/**
*/
bool AppendRows(size_t numRows = 1);
/**
*/
bool CanGetValueAs(int row, int col, const wxString& typeName);
@@ -101,22 +101,22 @@ public:
bool CanHaveAttributes();
/**
*/
bool CanSetValueAs(int row, int col, const wxString& typeName);
/**
*/
void Clear();
/**
*/
bool DeleteCols(size_t pos = 0, size_t numCols = 1);
/**
*/
bool DeleteRows(size_t pos = 0, size_t numRows = 1);
@@ -132,12 +132,12 @@ public:
wxGridCellAttrProvider* GetAttrProvider() const;
/**
*/
wxString GetColLabelValue(int col);
/**
*/
int GetNumberCols();
@@ -147,7 +147,7 @@ public:
int GetNumberRows();
/**
*/
wxString GetRowLabelValue(int row);
@@ -157,12 +157,12 @@ public:
wxString GetTypeName(int row, int col);
/**
*/
wxString GetValue(int row, int col);
/**
*/
bool GetValueAsBool(int row, int col);
@@ -173,32 +173,32 @@ public:
const wxString& typeName);
/**
*/
double GetValueAsDouble(int row, int col);
/**
*/
long GetValueAsLong(int row, int col);
/**
*/
wxGrid* GetView() const;
/**
*/
bool InsertCols(size_t pos = 0, size_t numCols = 1);
/**
*/
bool InsertRows(size_t pos = 0, size_t numRows = 1);
/**
*/
bool IsEmptyCell(int row, int col);
@@ -214,7 +214,7 @@ public:
void SetAttrProvider(wxGridCellAttrProvider* attrProvider);
/**
*/
void SetColAttr(wxGridCellAttr* attr, int col);
@@ -224,7 +224,7 @@ public:
void SetColLabelValue() const;
/**
*/
void SetRowAttr(wxGridCellAttr* attr, int row);
@@ -234,28 +234,28 @@ public:
void SetRowLabelValue() const;
/**
*/
void SetValue(int row, int col, const wxString& value);
/**
*/
void SetValueAsBool(int row, int col, bool value);
/**
*/
void SetValueAsCustom(int row, int col, const wxString& typeName,
void* value);
/**
*/
void SetValueAsDouble(int row, int col, double value);
/**
*/
void SetValueAsLong(int row, int col, long value);
@@ -265,7 +265,7 @@ public:
void SetView(wxGrid* grid);
/**
*/
void UpdateAttrCols(size_t pos, int numCols);
@@ -297,7 +297,7 @@ class wxGridCellEditor
{
public:
/**
*/
wxGridCellEditor();
@@ -341,7 +341,7 @@ public:
void HandleReturn(wxKeyEvent& event);
/**
*/
bool IsCreated();
@@ -489,7 +489,7 @@ class wxGridEditorCreatedEvent : public wxCommandEvent
public:
//@{
/**
*/
wxGridEditorCreatedEvent();
wxGridEditorCreatedEvent(int id, wxEventType type,
@@ -545,7 +545,7 @@ class wxGridRangeSelectEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridRangeSelectEvent();
wxGridRangeSelectEvent(int id, wxEventType type,
@@ -638,7 +638,7 @@ class wxGridCellRenderer
{
public:
/**
*/
wxGridCellRenderer* Clone() const;
@@ -717,7 +717,7 @@ class wxGridSizeEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridSizeEvent();
wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
@@ -817,7 +817,7 @@ public:
wxGridCellAttr* Clone() const;
/**
*/
void DecRef();
@@ -827,52 +827,52 @@ public:
void GetAlignment(int* hAlign, int* vAlign) const;
/**
*/
const wxColour GetBackgroundColour() const;
/**
*/
wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
/**
*/
const wxFont GetFont() const;
/**
*/
wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
/**
*/
const wxColour GetTextColour() const;
/**
*/
bool HasAlignment() const;
/**
*/
bool HasBackgroundColour() const;
/**
*/
bool HasEditor() const;
/**
*/
bool HasFont() const;
/**
*/
bool HasRenderer() const;
@@ -889,7 +889,7 @@ public:
void IncRef();
/**
*/
bool IsReadOnly() const;
@@ -906,12 +906,12 @@ public:
void SetBackgroundColour(const wxColour& colBack);
/**
*/
void SetDefAttr(wxGridCellAttr* defAttr);
/**
*/
void SetEditor(wxGridCellEditor* editor);
@@ -921,7 +921,7 @@ public:
void SetFont(const wxFont& font);
/**
*/
void SetReadOnly(bool isReadOnly = true);
@@ -976,7 +976,7 @@ class wxGridEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridEvent();
wxGridEvent(int id, wxEventType type, wxObject* obj,
@@ -1205,25 +1205,25 @@ public:
/**
AutoSizeColumn()
AutoSizeRow()
AutoSizeColumns()
AutoSizeRows()
AutoSize()
SetColMinimalWidth()
SetRowMinimalHeight()
SetColMinimalAcceptableWidth()
SetRowMinimalAcceptableHeight()
GetColMinimalAcceptableWidth()
GetRowMinimalAcceptableHeight()
*/
@@ -1236,7 +1236,7 @@ public:
EndBatch(). Code that does a lot of grid
modification can be enclosed between BeginBatch and EndBatch calls to avoid
screen flicker. The final EndBatch will cause the grid to be repainted.
@see wxGridUpdateLocker
*/
void BeginBatch();
@@ -1296,29 +1296,29 @@ public:
/**
EnableDragRowSize()
EnableDragColSize()
CanDragRowSize()
CanDragColSize()
EnableDragColMove()
CanDragColMove()
EnableDragGridSize()
CanDragGridSize()
GetColAt()
SetColPos()
GetColPos()
EnableDragCell()
CanDragCell()
*/
@@ -1348,11 +1348,11 @@ public:
/**
@ref ctor() wxGrid
@ref dtor() ~wxGrid
CreateGrid()
SetTable()
*/
@@ -1371,23 +1371,23 @@ public:
/**
MoveCursorUp()
MoveCursorDown()
MoveCursorLeft()
MoveCursorRight()
MoveCursorPageUp()
MoveCursorPageDown()
MoveCursorUpBlock()
MoveCursorDownBlock()
MoveCursorLeftBlock()
MoveCursorRightBlock()
*/
@@ -1505,7 +1505,7 @@ public:
EndBatch. Code that does a lot of grid modification can be enclosed between
BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
cause the grid to be repainted.
@see wxGridUpdateLocker
*/
void EndBatch();
@@ -1533,7 +1533,7 @@ public:
grid cell at the specified location.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
@@ -1605,7 +1605,7 @@ public:
Sets the arguments to the current column label alignment values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetColLabelAlignment(int* horiz, int* vert) const;
@@ -1626,7 +1626,7 @@ public:
wxString GetColLabelValue(int col) const;
/**
*/
int GetColLeft(int col) const;
@@ -1648,7 +1648,7 @@ public:
int GetColPos(int colID) const;
/**
*/
int GetColRight(int col) const;
@@ -1662,7 +1662,7 @@ public:
values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetDefaultCellAlignment(int* horiz, int* vert) const;
@@ -1702,14 +1702,14 @@ public:
//@{
/**
*/
wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
const wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
//@}
/**
*/
wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
@@ -1717,7 +1717,7 @@ public:
Returns the pen used for grid lines. This virtual function may be overridden in
derived classes in order to change the appearance of grid lines. Note that
currently the pen width must be 1.
@see GetColGridLinePen(), GetRowGridLinePen()
*/
wxPen GetDefaultGridLinePen();
@@ -1731,12 +1731,12 @@ public:
wxGridCellRenderer* GetDefaultRenderer() const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
@@ -1762,7 +1762,7 @@ public:
/**
Returns the colour used for grid lines.
@see GetDefaultGridLinePen()
*/
wxColour GetGridLineColour() const;
@@ -1796,7 +1796,7 @@ public:
int GetNumberRows() const;
/**
*/
wxGridCellAttr* GetOrCreateCellAttr(int row, int col) const;
@@ -1811,7 +1811,7 @@ public:
/**
Sets the arguments to the current row label alignment values.
Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT.
Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
*/
void GetRowLabelAlignment(int* horiz, int* vert) const;
@@ -1838,7 +1838,7 @@ public:
int GetRowMinimalAcceptableHeight() const;
/**
*/
int GetRowMinimalHeight(int col) const;
@@ -1849,14 +1849,14 @@ public:
/**
Returns the number of pixels per horizontal scroll increment. The default is 15.
@see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineX() const;
/**
Returns the number of pixels per vertical scroll increment. The default is 15.
@see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineY() const;
@@ -1894,7 +1894,7 @@ public:
wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
/**
*/
wxColour GetSelectionForeground() const;
@@ -1915,17 +1915,17 @@ public:
/**
EnableGridLines()
GridLinesEnabled()
SetGridLineColour()
GetGridLineColour()
GetDefaultGridLinePen()
GetRowGridLinePen()
GetColGridLinePen()
*/
@@ -2149,57 +2149,57 @@ public:
/**
SetRowLabelValue()
SetColLabelValue()
GetRowLabelValue()
GetColLabelValue()
SetUseNativeColLabels()
HideColLabels()
HideRowLabels()
SetRowLabelSize()
SetColLabelSize()
GetRowLabelSize()
GetColLabelSize()
AutoSizeRowLabelSize()
AutoSizeColLabelSize()
GetDefaultRowLabelSize()
GetDefaultColLabelSize()
SetRowLabelAlignment()
SetColLabelAlignment()
GetRowLabelAlignment()
GetColLabelAlignment()
SetLabelFont()
SetLabelTextColour()
SetLabelBackgroundColour()
GetLabelFont()
GetLabelBackgroundColour()
GetLabelTextColour()
SetColLabelTextOrientation()
GetColLabelTextOrientation()
*/
@@ -2249,15 +2249,15 @@ public:
/**
ClearSelection()
IsSelection()
SelectAll()
SelectBlock()
SelectCol()
SelectRow()
*/
@@ -2274,7 +2274,7 @@ public:
location.
Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or
wxALIGN_BOTTOM.
*/
@@ -2283,7 +2283,7 @@ public:
//@}
/**
*/
void SetCellBackgroundColour(int row, int col,
const wxColour& colour);
@@ -2539,7 +2539,7 @@ public:
int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = true);
/**
*/
int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = true);
@@ -2619,7 +2619,7 @@ public:
Sets the number of pixels per horizontal scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
*/
void SetScrollLineX(int x);
@@ -2628,24 +2628,24 @@ public:
Sets the number of pixels per vertical scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
*/
void SetScrollLineY(int y);
/**
*/
void SetSelectionBackground(const wxColour& c);
/**
*/
void SetSelectionForeground(const wxColour& c);
/**
Set the selection behaviour of the grid.
@param wxGridSelectCells()
The default mode where individual cells are selected.
@param wxGridSelectRows()

4
interface/help.h
View File

@@ -124,7 +124,7 @@ public:
@e WinHelp, MS HTML Help @a sectionNo is a context id.
@e External HTML help: wxExtHelpController implements @a sectionNo as an id in
a map file, which is of the form:
@e wxHtmlHelpController: @a sectionNo is an identifier as specified in the @c
.hhc file. See @ref overview_helpformat "Help files format".
See also the help sample for notes on how to specify section numbers for
@@ -145,7 +145,7 @@ public:
wxHtmlHelpController returns the frame, size and position.
For all other help controllers, this function does nothing
and just returns @NULL.
@param viewer
This defaults to "netscape" for wxExtHelpController.
@param flags

8
interface/htmllbox.h
View File

@@ -77,7 +77,7 @@ public:
wxVListBox::SetSelectionBackground allows to
change the selection background for all cells at once and doing anything more
fancy is probably going to look strangely.
@see GetSelectedTextColour()
*/
wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
@@ -88,7 +88,7 @@ public:
look inside selection. By default all original colours are completely ignored
and the standard, system-dependent, selection colour is used but the program
may wish to override this to achieve some custom appearance.
@see GetSelectedTextBgColour(),
wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
*/
@@ -117,12 +117,12 @@ public:
/**
Called when the user clicks on hypertext link. Does nothing by default.
Overloading this method is deprecated; intercept the event instead.
@param n
Index of the item containing the link.
@param link
Description of the link.
@see See also wxHtmlLinkInfo.
*/
virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);

2
interface/hyperlink.h
View File

@@ -81,7 +81,7 @@ class wxHyperlinkCtrl : public wxControl
public:
/**
Creates the hyperlink control.
@param parent
Parent window. Must not be @NULL.
@param id

232
interface/icon.h
View File

@@ -36,7 +36,7 @@ public:
//@{
/**
Loads an icon from the specified location().
@param bits
Specifies an array of pixel values.
@param width
@@ -66,68 +66,68 @@ public:
wxIconLocation.
@param type
May be one of the following:
wxBITMAP_TYPE_ICO
Load a Windows icon file.
wxBITMAP_TYPE_ICO_RESOURCE
Load a Windows icon from the resource database.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
If all possible wxWidgets settings are used, the Windows platform supports
@@ -136,7 +136,7 @@ public:
XPM data, XPM file, and PNG file.
Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM
file.
@remarks The first form constructs an icon object with no data; an
assignment or another member function such as Create or
LoadFile must be called subsequently.
@@ -168,9 +168,9 @@ public:
/**
Copies @a bmp bitmap to this icon. Under MS Windows the bitmap
must have mask colour set.
LoadFile()
Wx::Icon-new( width, height, depth = -1 )
Wx::Icon-new( name, type, desiredWidth = -1, desiredHeight = -1 )
Wx::Icon-newFromBits( bits, width, height, depth = 1 )
@@ -191,7 +191,7 @@ public:
/**
Gets the width of the icon in pixels.
@see GetHeight()
*/
int GetWidth() const;
@@ -203,86 +203,86 @@ public:
/**
Loads an icon from a file or resource.
@param name
Either a filename or a Windows resource name.
The meaning of name is determined by the type parameter.
@param type
One of the following values:
wxBITMAP_TYPE_ICO
Load a Windows icon file.
wxBITMAP_TYPE_ICO_RESOURCE
Load a Windows icon from the resource database.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
@returns @true if the operation succeeded, @false otherwise.
@see wxIcon()
*/
bool LoadFile(const wxString& name, wxBitmapType type);
/**
Sets the depth member (does not affect the icon data).
@param depth
Icon depth.
*/
@@ -290,7 +290,7 @@ public:
/**
Sets the height member (does not affect the icon data).
@param height
Icon height in pixels.
*/
@@ -298,7 +298,7 @@ public:
/**
Sets the width member (does not affect the icon data).
@param width
Icon width in pixels.
*/
@@ -306,7 +306,7 @@ public:
/**
Assignment operator, using @ref overview_trefcount "reference counting".
@param icon
Icon to assign.
*/

1012
interface/image.h
View File

File diff suppressed because it is too large Load Diff

96
interface/imaglist.h
View File

@@ -30,7 +30,7 @@ public:
/**
Constructor specifying the image size, whether image masks should be created,
and the initial size of the list.
@param width
Width of the images in the list.
@param height
@@ -39,7 +39,7 @@ public:
@true if masks should be created for all images.
@param initialCount
The initial size of the list.
@see Create()
*/
wxImageList();
@@ -50,7 +50,7 @@ public:
//@{
/**
Adds a new image using an icon.
@param bitmap
Bitmap representing the opaque areas of the image.
@param mask
@@ -59,9 +59,9 @@ public:
Colour indicating which parts of the image are transparent.
@param icon
Icon to use as the image.
@returns The new zero-based image index.
@remarks The original bitmap or icon is not affected by the Add
operation, and can be deleted afterwards.
*/
@@ -79,7 +79,7 @@ public:
/**
Draws a specified image onto a device context.
@param index
Image index, starting from zero.
@param dc
@@ -90,50 +90,50 @@ public:
Y position on the device context.
@param flags
How to draw the image. A bitlist of a selection of the following:
wxIMAGELIST_DRAW_NORMAL
Draw the image normally.
wxIMAGELIST_DRAW_TRANSPARENT
Draw the image with transparency.
wxIMAGELIST_DRAW_SELECTED
Draw the image in selected state.
wxIMAGELIST_DRAW_FOCUSED
Draw the image in a focused state.
@param solidBackground
For optimisation - drawing can be faster if the function is told
@@ -161,14 +161,14 @@ public:
/**
Retrieves the size of the images in the list. Currently, the @a index
parameter is ignored as all images in the list have the same size.
@param index
currently unused, should be 0
@param width
receives the width of the images in the list
@param height
receives the height of the images in the list
@returns @true if the function succeeded, @false if it failed (for example,
if the image list was not yet initialized).
*/
@@ -187,16 +187,16 @@ public:
//@{
/**
Replaces the existing image with the new image.
@param bitmap
Bitmap representing the opaque areas of the image.
@param mask
Monochrome mask bitmap, representing the transparent areas of the image.
@param icon
Icon to use as the image.
@returns @true if the replacement was successful, @false otherwise.
@remarks The original bitmap or icon is not affected by the Replace
operation, and can be deleted afterwards.
*/

50
interface/intl.h
View File

@@ -151,7 +151,7 @@ public:
Returns the information for the given language or @NULL if this language
is unknown. Note that even if the returned pointer is valid, the caller should
@e not delete it.
@see GetLanguageInfo()
*/
static wxLanguageInfo* FindLanguageInfo(const wxString& locale);
@@ -235,7 +235,7 @@ public:
See GNU gettext manual for additional information on plural forms handling.
This method is called by the wxGetTranslation()
function and _() macro.
@remarks Domains are searched in the last to first order, i.e. catalogs
added later override those added before.
*/
@@ -281,7 +281,7 @@ public:
/**
The second form is deprecated, use the first one unless you know what you are
doing.
@param language
wxLanguage identifier of the locale.
wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
@@ -289,32 +289,32 @@ public:
language (see GetSystemLanguage).
@param flags
Combination of the following:
wxLOCALE_LOAD_DEFAULT
Load the message catalog
for the given locale containing the translations of standard wxWidgets
messages
automatically.
wxLOCALE_CONV_ENCODING
Automatically convert message
catalogs to platform's default encoding. Note that it will do only basic
conversion between well-known pair like iso8859-1 and windows-1252 or
@@ -363,7 +363,7 @@ public:
FindLanguageInfo() to obtain its
wxLanguageInfo structure. See AddLanguage() for
the wxLanguageInfo description.
@wxsince{2.7.1}.
*/
static bool IsAvailable(int lang);
@@ -526,7 +526,7 @@ public:
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@see wxLocale
*/
};

14
interface/joystick.h
View File

@@ -35,7 +35,7 @@ public:
//@{
/**
Returns the state of the specified joystick button.
@param id
The button id to report, from 0 to GetNumberButtons() - 1
*/
@@ -98,7 +98,7 @@ public:
//@{
/**
Returns the position of the specified joystick axis.
@param axis
The joystick axis to report, from 0 to GetNumberAxes() - 1.
*/
@@ -239,25 +239,25 @@ public:
/**
Releases the capture set by @b SetCapture.
@returns @true if the capture release succeeded.
@see SetCapture(), wxJoystickEvent
*/
bool ReleaseCapture();
/**
Sets the capture to direct joystick events to @e win.
@param win
The window that will receive joystick events.
@param pollingFreq
If zero, movement events are sent when above the
threshold. If greater than zero, events are received every pollingFreq
milliseconds.
@returns @true if the capture succeeded.
@see ReleaseCapture(), wxJoystickEvent
*/
bool SetCapture(wxWindow* win, int pollingFreq = 0);

4
interface/laywin.h
View File

@@ -161,7 +161,7 @@ public:
/**
Constructs a sash layout window, which can be a child of a frame, dialog or any
other non-control window.
@param parent
Pointer to a parent window.
@param id
@@ -192,7 +192,7 @@ public:
/**
Initializes a sash layout window, which can be a child of a frame, dialog or
any other non-control window.
@param parent
Pointer to a parent window.
@param id

4
interface/link.h
View File

@@ -12,7 +12,7 @@
/**
This macro can be used in conjunction with the wxFORCE_LINK_MODULE() macro
to force the linker to include in its output a specific object file.
In particular, you should use this macro in the source file which you want
to force for inclusion. The @c moduleName needs to be a name not already in
use in other wxFORCE_LINK_THIS_MODULE() macros, but is not required to be
@@ -25,7 +25,7 @@
/**
This macro can be used in conjunction with the wxFORCE_LINK_THIS_MODULE()
macro to force the linker to include in its output a specific object file.
In particular, you should use this macro in a source file which you know
for sure is linked in the output (e.g. the source file containing the
@c main() of your app). The @c moduleName is the name of the module you

34
interface/listbox.h
View File

@@ -64,7 +64,7 @@ public:
//@{
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -85,7 +85,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxListBox();
@@ -135,25 +135,25 @@ public:
/**
Deselects an item in the list box.
@param n
The zero-based item to deselect.
@remarks This applies to multiple selection listboxes only.
*/
void Deselect(int n);
/**
Fill an array of ints with the positions of the currently selected items.
@param selections
A reference to an wxArrayInt instance that is used to store the result of
the query.
@returns The number of selections.
@remarks Use this with a multiple selection listbox.
@see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
wxControlWithItems::SetSelection
*/
@@ -162,14 +162,14 @@ public:
/**
Returns the item located at @e point, or @c wxNOT_FOUND if there
is no item located at @e point.
@wxsince{2.7.0}. It is currently implemented
for wxMSW, wxMac and wxGTK2
ports.
@param point
Point of item (in client coordinates) to obtain
@returns Item located at point, or wxNOT_FOUND if unimplemented or the
item does not exist.
*/
@@ -178,7 +178,7 @@ public:
//@{
/**
Insert the given number of strings before the specified position.
@param nItems
Number of items in the array items
@param items
@@ -196,10 +196,10 @@ public:
/**
Determines whether an item is selected.
@param n
The zero-based item index.
@returns @true if the given item is selected, @false otherwise.
*/
bool IsSelected(int n) const;
@@ -207,14 +207,14 @@ public:
//@{
/**
Clears the list box and adds the given strings to it.
@param n
The number of strings to set.
@param choices
An array of strings to set.
@param clientData
Options array of client data pointers
@remarks You may free the array from the calling program after this
function has been called.
*/
@@ -226,7 +226,7 @@ public:
//@{
/**
Set the specified item to be the first visible item.
@param n
The zero-based item index.
@param string

218
interface/listctrl.h
View File

@@ -95,7 +95,7 @@ public:
//@{
/**
Constructor, creating and showing a list control.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -112,7 +112,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxListCtrl();
@@ -132,21 +132,21 @@ public:
/**
Arranges the items in icon or small icon view. This only has effect on Win32.
@a flag is one of:
wxLIST_ALIGN_DEFAULT
Default alignment.
wxLIST_ALIGN_LEFT
Align to the left side of the control.
wxLIST_ALIGN_TOP
Align to the top side of the control.
wxLIST_ALIGN_SNAP_TO_GRID
Snap to grid.
*/
bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
@@ -157,7 +157,7 @@ public:
SetImageList, delete the list when destroyed). @a which is one of
wxIMAGE_LIST_NORMAL, wxIMAGE_LIST_SMALL, wxIMAGE_LIST_STATE (the last is
unimplemented).
@see SetImageList()
*/
void AssignImageList(wxImageList* imageList, int which);
@@ -216,14 +216,14 @@ public:
/**
Find an item nearest this position in the specified direction, starting from
@a start or the beginning if @a start is -1.
@b FindItem( start, str, partial = @false )
@b FindItemData( start, data )
@b FindItemAtPos( start, point, direction )
*/
long FindItem(long start, const wxString& str,
@@ -282,17 +282,17 @@ public:
/**
Returns the specified image list. @a which may be one of:
@b wxIMAGE_LIST_NORMAL
The normal (large icon) image list.
@b wxIMAGE_LIST_SMALL
The small icon image list.
@b wxIMAGE_LIST_STATE
The user-defined state image list (unimplemented).
*/
wxImageList* GetImageList(int which) const;
@@ -309,7 +309,7 @@ public:
Returns the colour for this item. If the item has no specific colour, returns
an invalid colour (and not the default background control of the control
itself).
@see GetItemTextColour()
*/
wxColour GetItemBackgroundColour(long item) const;
@@ -376,51 +376,51 @@ public:
Returns the first item with given state following @a item or -1 if
no such item found.
This function may be used to find all selected items in the control like this:
@a geometry can be one of:
wxLIST_NEXT_ABOVE
Searches for an item above the specified item.
wxLIST_NEXT_ALL
Searches for subsequent item by index.
wxLIST_NEXT_BELOW
Searches for an item below the specified item.
wxLIST_NEXT_LEFT
Searches for an item to the left of the specified item.
wxLIST_NEXT_RIGHT
Searches for an item to the right of the specified item.
@b NB: this parameter is only supported by wxMSW currently and ignored on
other platforms.
@a state can be a bitlist of the following:
wxLIST_STATE_DONTCARE
Don't care what the state is.
wxLIST_STATE_DROPHILITED
The item indicates it is a drop target.
wxLIST_STATE_FOCUSED
The item has the focus.
wxLIST_STATE_SELECTED
The item is selected.
wxLIST_STATE_CUT
The item is selected as part of a cut and paste operation.
*/
long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL,
@@ -441,7 +441,7 @@ public:
for GetItemRect().
@a code can be one of @c wxLIST_RECT_BOUNDS,
@c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL.
@wxsince{2.7.0}
*/
bool GetSubItemRect(long item, long subItem, wxRect& rect,
@@ -472,48 +472,48 @@ public:
giving details in @e flags. Returns index of the item or @c wxNOT_FOUND
if no item is at the specified point.
@a flags will be a combination of the following flags:
wxLIST_HITTEST_ABOVE
Above the client area.
wxLIST_HITTEST_BELOW
Below the client area.
wxLIST_HITTEST_NOWHERE
In the client area but below the last item.
wxLIST_HITTEST_ONITEMICON
On the bitmap associated with an item.
wxLIST_HITTEST_ONITEMLABEL
On the label (string) associated with an item.
wxLIST_HITTEST_ONITEMRIGHT
In the area to the right of an item.
wxLIST_HITTEST_ONITEMSTATEICON
On the state icon for a tree view item that is in a user-defined state.
wxLIST_HITTEST_TOLEFT
To the right of the client area.
wxLIST_HITTEST_TORIGHT
To the left of the client area.
wxLIST_HITTEST_ONITEM
Combination of wxLIST_HITTEST_ONITEMICON, wxLIST_HITTEST_ONITEMLABEL,
wxLIST_HITTEST_ONITEMSTATEICON.
If @a ptrSubItem is not @NULL and the wxListCtrl is in the report
mode the subitem (or column) number will also be provided.
This feature is only available in version 2.7.0 or higher and is currently only
@@ -538,7 +538,7 @@ public:
//@{
/**
Insert an image/string item.
@param info
wxListItem object
@param index
@@ -563,7 +563,7 @@ public:
wxListCtrl will not delete the pointer or keep a reference of it. You can
return the same wxListItemAttr pointer for every OnGetItemAttr call.
The base class version always returns @NULL.
@see OnGetItemImage(), OnGetItemColumnImage(),
OnGetItemText()
*/
@@ -575,7 +575,7 @@ public:
index for the given line and column.
The base class version always calls OnGetItemImage for the first column, else
it returns -1.
@see OnGetItemText(), OnGetItemImage(),
OnGetItemAttr()
*/
@@ -590,7 +590,7 @@ public:
In a control with @c wxLC_REPORT style, OnGetItemImage only gets called for
the first column of each line.
The base class version always returns -1.
@see OnGetItemText(), OnGetItemColumnImage(),
OnGetItemAttr()
*/
@@ -600,7 +600,7 @@ public:
This function @b must be overloaded in the derived class for a control with
@c wxLC_VIRTUAL style. It should return the string containing the text of
the given @a column for the specified @c item.
@see SetItemCount(), OnGetItemImage(),
OnGetItemColumnImage(), OnGetItemAttr()
*/
@@ -610,7 +610,7 @@ public:
Redraws the given @e item. This is only useful for the virtual list controls
as without calling this function the displayed value of the item doesn't change
even when the underlying data does change.
@see RefreshItems()
*/
void RefreshItem(long item);
@@ -671,7 +671,7 @@ public:
unimplemented).
This method does not take ownership of the image list, you have to
delete it yourself.
@see AssignImageList()
*/
void SetImageList(wxImageList* imageList, int which);
@@ -874,7 +874,7 @@ The m_stateMask and m_state members take flags from the following:
be either an integer or a pointer cast to the @c wxUIntPtr type which is
guaranteed to be large enough to be able to contain all integer types and
pointers.
@wxsince{2.8.4}
*/
bool SetItemPtrData(long item, wxUIntPtr data);
@@ -916,12 +916,12 @@ The m_stateMask and m_state members take flags from the following:
Call this function to sort the items in the list control. Sorting is done
using the specified @a fnSortCallBack function. This function must have the
following prototype:
It is called each time when the two items must be compared and should return 0
if the items are equal, negative value if the first item is less than the
second one and positive value if the first one is greater than the second one
(the same convention as used by @c qsort(3)).
@param item1
client data associated with the first item (NOT the index).
@param item2
@@ -1131,10 +1131,10 @@ class wxListView : public wxListCtrl
public:
/**
Resets the column image -- after calling this function, no image will be shown.
@param col
the column to clear image for
@see SetColumnImage()
*/
void ClearColumnImage(int col);
@@ -1148,14 +1148,14 @@ public:
Returns the first selected item in a (presumably) multiple selection control.
Together with GetNextSelected() it can be
used to iterate over all selected items in the control.
@returns The first selected item, if any, -1 otherwise.
*/
long GetFirstSelected() const;
/**
Returns the currently focused item or -1 if none.
@see IsSelected(), Focus()
*/
long GetFocusedItem() const;
@@ -1163,7 +1163,7 @@ public:
/**
Used together with GetFirstSelected() to
iterate over all selected items in the control.
@returns Returns the next selected item or -1 if there are no more of
them.
*/
@@ -1172,19 +1172,19 @@ public:
/**
Returns @true if the item with the given @a index is selected,
@false otherwise.
@see GetFirstSelected(), GetNextSelected()
*/
bool IsSelected(long index) const;
/**
Selects or unselects the given item.
@param n
the item to select or unselect
@param on
if @true (default), selects the item, otherwise unselects it
@see wxListCtrl::SetItemState
*/
void Select(bool on = true);
@@ -1192,7 +1192,7 @@ public:
/**
Sets the column image for the specified column. To use the column images, the
control must have a valid image list with at least one image.
@param col
the column to set image for
@param image
@@ -1266,29 +1266,29 @@ public:
/**
Returns a bit mask indicating which fields of the structure are valid;
can be any combination of the following values:
wxLIST_MASK_STATE
@b GetState is valid.
wxLIST_MASK_TEXT
@b GetText is valid.
wxLIST_MASK_IMAGE
@b GetImage is valid.
wxLIST_MASK_DATA
@b GetData is valid.
wxLIST_MASK_WIDTH
@b GetWidth is valid.
wxLIST_MASK_FORMAT
@b GetFormat is valid.
*/
long GetMask() const;
@@ -1296,25 +1296,25 @@ public:
/**
Returns a bit field representing the state of the item. Can be any
combination of:
wxLIST_STATE_DONTCARE
Don't care what the state is. Win32 only.
wxLIST_STATE_DROPHILITED
The item is highlighted to receive a drop event. Win32 only.
wxLIST_STATE_FOCUSED
The item has the focus.
wxLIST_STATE_SELECTED
The item is selected.
wxLIST_STATE_CUT
The item is in the cut state. Win32 only.
*/
long GetState() const;

56
interface/log.h
View File

@@ -26,7 +26,7 @@ class wxLogWindow : public wxLogInterposer
public:
/**
Creates the log frame window and starts collecting the messages in it.
@param parent
The parent window for the log frame, may be @NULL
@param title
@@ -54,7 +54,7 @@ public:
exits).
Return @true from here to allow the frame to close, @false to
prevent this from happening.
@see OnFrameDelete()
*/
virtual bool OnFrameClose(wxFrame frame);
@@ -384,7 +384,7 @@ public:
/**
Add the @a mask to the list of allowed masks for
wxLogTrace().
@see RemoveTraceMask(), GetTraceMasks()
*/
static void AddTraceMask(const wxString& mask);
@@ -392,7 +392,7 @@ public:
/**
Removes all trace masks previously set with
AddTraceMask().
@see RemoveTraceMask()
*/
static void ClearTraceMasks();
@@ -417,12 +417,12 @@ public:
current mask while a message using string mask will be logged simply if the
mask had been added before to the list of allowed ones.
For example,
will do something only if the current trace mask contains both
@c wxTraceRefCount and @c wxTraceOle, but
will log the message if it was preceded by
Using string masks is simpler and allows to easily add custom ones, so this is
the preferred way of working with trace messages. The integer trace mask is
kept for compatibility and for additional (but very rarely needed) flexibility
@@ -442,29 +442,29 @@ public:
window on the corresponding error message. If you wish to enable it, please use
SetTimestamp() explicitly.
AddTraceMask()
RemoveTraceMask()
ClearTraceMasks()
GetTraceMasks()
IsAllowedTraceMask()
SetVerbose()
GetVerbose()
SetTimestamp()
GetTimestamp()
SetTraceMask()
GetTraceMask()
SetRepetitionCounting()
GetRepetitionCounting()
*/
@@ -511,7 +511,7 @@ public:
/**
Flushes the current log target if any, does nothing if there is none.
@see Flush()
*/
static void FlushActive();
@@ -544,7 +544,7 @@ public:
/**
Returns the currently allowed list of string trace masks.
@see AddTraceMask().
*/
static const wxArrayString GetTraceMasks();
@@ -564,15 +564,15 @@ public:
only useful when the application is terminating and shouldn't be used in other
situations because it may easily lead to a loss of messages.
OnLog()
GetActiveTarget()
SetActiveTarget()
DontCreateOnDemand()
Suspend()
Resume()
*/
@@ -605,7 +605,7 @@ public:
Flush() shows them all and clears the buffer contents.
This function doesn't do anything if the buffer is already empty.
Flush()
FlushActive()
*/
@@ -680,7 +680,7 @@ public:
logging immediately without waiting for Flush() to be
called (the standard GUI log target only shows the log dialog when it is
flushed, so Suspend() works as expected with it).
@see Resume(), wxLogNull
*/
static void Suspend();

2
interface/longlong.h
View File

@@ -133,7 +133,7 @@ public:
/**
Assignment operator from unsigned long long. The sign bit will be copied too.
@wxsince{2.7.0}
*/
wxLongLong& operator operator=(const wxULongLong& ll);

50
interface/mdi.h
View File

@@ -24,15 +24,15 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent.
@param style
The window style. Currently unused.
@remarks The second style of constructor is called within
wxMDIParentFrame::OnCreateClient.
@see wxMDIParentFrame::wxMDIParentFrame, wxMDIParentFrame::OnCreateClient
*/
wxMDIClientWindow();
@@ -109,7 +109,7 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent. This should be @NULL.
@param id
@@ -131,12 +131,12 @@ public:
item,
allowing the application user to set Motif resource values for
individual windows.
@remarks During the construction of the frame, the client window will be
created. To use a different class from
wxMDIClientWindow, override
OnCreateClient().
@see Create(), OnCreateClient()
*/
wxMDIParentFrame();
@@ -155,28 +155,28 @@ public:
/**
Activates the MDI child following the currently active one.
@see ActivatePrevious()
*/
void ActivateNext();
/**
Activates the MDI child preceding the currently active one.
@see ActivateNext()
*/
void ActivatePrevious();
/**
Arranges any iconized (minimized) MDI child windows.
@see Cascade(), Tile()
*/
void ArrangeIcons();
/**
Arranges the MDI child windows in a cascade.
@see Tile(), ArrangeIcons()
*/
void Cascade();
@@ -199,16 +199,16 @@ public:
/**
This gets the size of the frame 'client area' in pixels.
@param width
Receives the client width in pixels.
@param height
Receives the client height in pixels.
@remarks The client area is the area which may be drawn on by the
programmer, excluding title bar, border, status bar,
and toolbar if present.
@see GetToolBar(), SetToolBar(),
wxMDIClientWindow
*/
@@ -216,14 +216,14 @@ public:
/**
Returns a pointer to the client window.
@see OnCreateClient()
*/
wxMDIClientWindow* GetClientWindow() const;
/**
Returns the window being used as the toolbar for this frame.
@see SetToolBar()
*/
virtual wxWindow* GetToolBar() const;
@@ -242,11 +242,11 @@ public:
called,
due to the way C++ treats virtual functions called from constructors. For
example:
@remarks You might wish to derive from wxMDIClientWindow in order to
implement different erase behaviour, for example, such
as painting a bitmap on the background.
@see GetClientWindow(), wxMDIClientWindow
*/
virtual wxMDIClientWindow* OnCreateClient();
@@ -255,14 +255,14 @@ public:
Sets the window to be used as a toolbar for this
MDI parent window. It saves the application having to manage the positioning
of the toolbar MDI client window.
@param toolbar
Toolbar to manage.
@remarks When the frame is resized, the toolbar is resized to be the
width of the frame client area, and the toolbar height
is kept the same.
@see GetToolBar(), GetClientSize()
*/
virtual void SetToolBar(wxWindow* toolbar);
@@ -331,7 +331,7 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent. This should not be @NULL.
@param id
@@ -353,9 +353,9 @@ public:
item,
allowing the application user to set Motif resource values for
individual windows.
@remarks None.
@see Create()
*/
wxMDIChildFrame();
@@ -374,7 +374,7 @@ public:
/**
Activates this MDI child frame.
@see Maximize(), Restore()
*/
void Activate();
@@ -392,7 +392,7 @@ public:
/**
Maximizes this MDI child frame.
@see Activate(), Restore()
*/
void Maximize(bool maximize);

66
interface/mediactrl.h
View File

@@ -46,7 +46,7 @@ public:
/**
,
wxPoint&
@param pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
@@ -54,10 +54,10 @@ public:
const wxValidatorvalidator = wxDefaultValidator,
const wxString& name = wxPanelNameStr
)
Constructor that calls Create. You may prefer to call Create directly to check
to see if wxMediaCtrl is available on the system.
parent
parent of this control. Must not be @NULL.
@param id
@@ -90,35 +90,35 @@ public:
name of the backend class to
Create().
The following are valid backend identifiers -
@b wxMEDIABACKEND_DIRECTSHOW
Use ActiveMovie/DirectShow. Uses the native ActiveMovie
(I.E. DirectShow) control. Default backend on Windows and
supported by nearly all Windows versions, even some
Windows CE versions. May display a windows media player
logo while inactive.
@b wxMEDIABACKEND_QUICKTIME
Use QuickTime. Mac Only.
WARNING: May not working correctly embedded in a wxNotebook.
@b wxMEDIABACKEND_GSTREAMER
Use GStreamer. Unix Only. Requires GStreamer 0.8 along
with at the very least the xvimagesink, xoverlay, and
gst-play modules of gstreamer to function. You need the correct
modules to play the relavant files, for example the mad module
to play mp3s, etc.
@b wxMEDIABACKEND_WMP10
Uses Windows Media Player 10 (Windows only) - works on mobile
machines with Windows Media Player 10 and desktop machines with
either Windows Media Player 9 or 10
Note that other backends such as wxMEDIABACKEND_MCI can now be
found at wxCode.
*/
@@ -127,7 +127,7 @@ public:
/**
,
wxPoint&
@param pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
@@ -135,13 +135,13 @@ public:
const wxValidatorvalidator = wxDefaultValidator,
const wxString& name = wxPanelNameStr
)
Creates this control. Returns @false if it can't load the movie located at
fileName or it cannot load one of its native backends.
If you specify a file to open via fileName and you don't specify a backend to
use, wxMediaCtrl tries each of its backends until one that can render the path referred to by fileName can be found.
parent
parent of this control. Must not be @NULL.
@param id
@@ -196,17 +196,17 @@ public:
/**
Obtains the state the playback of the media is in -
@b wxMEDIASTATE_STOPPED
The movie has stopped.
@b wxMEDIASTATE_PAUSED
The movie is paused.
@b wxMEDIASTATE_PLAYING
The movie is currently playing.
*/
wxMediaCtrlState GetState();
@@ -246,7 +246,7 @@ public:
can choose to veto the event, preventing the stream from actually
stopping.
Example:
When wxMediaCtrl stops, either by the EVT_MEDIA_STOP not being
vetoed, or by manually calling
Stop(), where it actually
@@ -341,24 +341,24 @@ public:
calling the function with default parameters tells wxMediaCtrl to use the
default controls provided by the toolkit. The function takes a
@c wxMediaCtrlPlayerControls enumeration as follows:
@b wxMEDIACTRLPLAYERCONTROLS_NONE
No controls. return wxMediaCtrl to it's default state.
@b wxMEDIACTRLPLAYERCONTROLS_STEP
Step controls like fastfoward, step one frame etc.
@b wxMEDIACTRLPLAYERCONTROLS_VOLUME
Volume controls like the speaker icon, volume slider, etc.
@b wxMEDIACTRLPLAYERCONTROLS_DEFAULT
Default controls for the toolkit. Currently a typedef for
wxMEDIACTRLPLAYERCONTROLS_STEP and wxMEDIACTRLPLAYERCONTROLS_VOLUME.
For more see @ref overview_playercontrolswxmediactrl "Player controls".
Currently
only implemented on the QuickTime and DirectShow backends. The function

30
interface/memory.h
View File

@@ -53,7 +53,7 @@ public:
/**
Checks the memory blocks for errors, starting from the currently set
checkpoint.
@returns Returns the number of errors, so a value of zero represents
success. Returns -1 if an error was detected that
prevents further checking.
@@ -64,7 +64,7 @@ public:
Performs a memory dump from the currently set checkpoint, writing to the
current debug stream. Calls the @b Dump member function for each wxObject
derived instance.
@returns @true if the function succeeded, @false otherwise.
*/
bool Dump();
@@ -73,7 +73,7 @@ public:
Returns @true if the memory allocator checks all previous memory blocks for
errors.
By default, this is @false since it slows down execution considerably.
@see SetCheckPrevious()
*/
bool GetCheckPrevious();
@@ -83,7 +83,7 @@ public:
delete
operators store or use information about memory allocation. Otherwise,
a straight malloc and free will be performed by these operators.
@see SetDebugMode()
*/
bool GetDebugMode();
@@ -96,7 +96,7 @@ public:
application
specify a value other than one.
This is obsolete, replaced by wxLog functionality.
@see SetLevel()
*/
int GetLevel();
@@ -104,7 +104,7 @@ public:
/**
Returns the output stream associated with the debug context.
This is obsolete, replaced by wxLog functionality.
@see SetStream()
*/
ostream GetStream();
@@ -121,7 +121,7 @@ public:
Returns @true if there is a stream currently associated
with the debug context.
This is obsolete, replaced by wxLog functionality.
@see SetStream(), GetStream()
*/
bool HasStream();
@@ -129,7 +129,7 @@ public:
/**
Prints a list of the classes declared in this application, giving derivation
and whether instances of this class can be dynamically created.
@see PrintStatistics()
*/
bool PrintClasses();
@@ -138,12 +138,12 @@ public:
Performs a statistics analysis from the currently set checkpoint, writing
to the current debug stream. The number of object and non-object
allocations is printed, together with the total size.
@param detailed
If @true, the function will also print how many
objects of each class have been allocated, and the space taken by
these class instances.
@see PrintStatistics()
*/
bool PrintStatistics(bool detailed = true);
@@ -151,7 +151,7 @@ public:
/**
Tells the memory allocator to check all previous memory blocks for errors.
By default, this is @false since it slows down execution considerably.
@see GetCheckPrevious()
*/
void SetCheckPrevious(bool check);
@@ -160,7 +160,7 @@ public:
Sets the current checkpoint: Dump and PrintStatistics operations will
be performed from this point on. This allows you to ignore allocations
that have been performed up to this point.
@param all
If @true, the checkpoint is reset to include all
memory allocations since the program started.
@@ -176,7 +176,7 @@ public:
is deallocated with the same value of debug mode. Otherwise, the
delete operator might try to look for memory information that does not
exist.
@see GetDebugMode()
*/
void SetDebugMode(bool debug);
@@ -196,7 +196,7 @@ public:
application
specify a value other than one.
This is obsolete, replaced by wxLog functionality.
@see GetLevel()
*/
void SetLevel(int level);
@@ -223,7 +223,7 @@ public:
This operation flushes and deletes the existing stream (and stream buffer if
any).
This is obsolete, replaced by wxLog functionality.
@param stream
Stream to associate with the debug context. Do not set this to @NULL.
@param streamBuf

212
interface/menu.h
View File

@@ -23,7 +23,7 @@ public:
//@{
/**
Construct a menu bar from arrays of menus and titles.
@param n
The number of menus.
@param menus
@@ -48,26 +48,26 @@ public:
/**
Adds the item to the end of the menu bar.
@param menu
The menu to add. Do not deallocate this menu after calling Append.
@param title
The title of the menu.
@returns @true on success, @false if an error occurred.
@see Insert()
*/
bool Append(wxMenu* menu, const wxString& title);
/**
Checks or unchecks a menu item.
@param id
The menu item identifier.
@param check
If @true, checks the menu item, otherwise the item is unchecked.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
@@ -75,12 +75,12 @@ public:
/**
Enables or disables (greys out) a menu item.
@param id
The menu item identifier.
@param enable
@true to enable the item, @false to disable it.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
@@ -88,24 +88,24 @@ public:
/**
Enables or disables a whole menu.
@param pos
The position of the menu, starting from zero.
@param enable
@true to enable the menu, @false to disable it.
@remarks Only use this when the menu bar has been associated with a frame.
*/
void EnableTop(int pos, const bool enable);
/**
Finds the menu item object associated with the given menu item identifier.
@param id
Menu item identifier.
@param menu
If not @NULL, menu will get set to the associated menu.
@returns The found menu item object, or @NULL if one was not found.
*/
wxMenuItem* FindItem(int id, wxMenu menu = NULL) const;
@@ -120,14 +120,14 @@ public:
/**
Finds the menu item id for a menu name/menu item string pair.
@param menuString
Menu title to find.
@param itemString
Item to find.
@returns The menu item identifier, or wxNOT_FOUND if none was found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
*/
@@ -136,26 +136,26 @@ public:
/**
Gets the help string associated with the menu item identifier.
@param id
The menu item identifier.
@returns The help string, or the empty string if there was no help string
or the menu item was not found.
@see SetHelpString()
*/
wxString GetHelpString(int id) const;
/**
Gets the label associated with a menu item.
@param id
The menu item identifier.
@returns The menu item label, or the empty string if the item was not
found.
@remarks Use only after the menubar has been associated with a frame.
*/
wxString GetLabel(int id) const;
@@ -164,14 +164,14 @@ public:
Returns the label of a top-level menu. Note that the returned string does not
include the accelerator characters which could have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see SetLabelTop()
*/
wxString GetLabelTop(int pos) const;
@@ -190,14 +190,14 @@ public:
Returns the label of a top-level menu. Note that the returned string
includes the accelerator characters that have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see GetMenuLabelText(), SetMenuLabel()
*/
wxString GetMenuLabel(int pos) const;
@@ -206,14 +206,14 @@ public:
Returns the label of a top-level menu. Note that the returned string does not
include any accelerator characters that may have been specified in the menu
title string during its construction.
@param pos
Position of the menu on the menu bar, starting from zero.
@returns The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@see GetMenuLabel(), SetMenuLabel()
*/
wxString GetMenuLabelText(int pos) const;
@@ -223,36 +223,36 @@ public:
position 0 will insert it in the very beginning of it, inserting at position
GetMenuCount() is the same as calling
Append().
@param pos
The position of the new menu in the menu bar
@param menu
The menu to add. wxMenuBar owns the menu and will free it.
@param title
The title of the menu.
@returns @true on success, @false if an error occurred.
@see Append()
*/
bool Insert(size_t pos, wxMenu* menu, const wxString& title);
/**
Determines whether an item is checked.
@param id
The menu item identifier.
@returns @true if the item was found and is checked, @false otherwise.
*/
bool IsChecked(int id) const;
/**
Determines whether an item is enabled.
@param id
The menu item identifier.
@returns @true if the item was found and is enabled, @false otherwise.
*/
bool IsEnabled(int id) const;
@@ -267,76 +267,76 @@ public:
responsible for deleting it. This function may be used together with
Insert() to change the menubar
dynamically.
@see Replace()
*/
wxMenu* Remove(size_t pos);
/**
Replaces the menu at the given position with another one.
@param pos
The position of the new menu in the menu bar
@param menu
The menu to add.
@param title
The title of the menu.
@returns The menu which was previously at position pos. The caller is
responsible for deleting it.
@see Insert(), Remove()
*/
wxMenu* Replace(size_t pos, wxMenu* menu, const wxString& title);
/**
Sets the help string associated with a menu item.
@param id
Menu item identifier.
@param helpString
Help string to associate with the menu item.
@see GetHelpString()
*/
void SetHelpString(int id, const wxString& helpString);
/**
Sets the label of a menu item.
@param id
Menu item identifier.
@param label
Menu item label.
@remarks Use only after the menubar has been associated with a frame.
@see GetLabel()
*/
void SetLabel(int id, const wxString& label);
/**
Sets the label of a top-level menu.
@param pos
The position of a menu on the menu bar, starting from zero.
@param label
The menu label.
@remarks Use only after the menubar has been associated with a frame.
@see GetLabelTop()
*/
void SetLabelTop(int pos, const wxString& label);
/**
Sets the label of a top-level menu.
@param pos
The position of a menu on the menu bar, starting from zero.
@param label
The menu label.
@remarks Use only after the menubar has been associated with a frame.
*/
void SetMenuLabel(int pos, const wxString& label);
@@ -394,7 +394,7 @@ public:
//@{
/**
Constructs a wxMenu object.
@param style
If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
*/
@@ -419,7 +419,7 @@ public:
because it may be used for both items (including separators) and submenus and
because you can also specify various extra properties of a menu item this way,
such as bitmaps and fonts.
@param id
The menu command identifier.
@param item
@@ -436,10 +436,10 @@ public:
@param menuItem
A menuitem object. It will be owned by the wxMenu object after this function
is called, so do not delete it yourself.
@remarks This command can be used after the menu has been shown, as well
as on initial creation of a menu or menubar.
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
AppendSubMenu(), Insert(), SetLabel(),
GetHelpString(), SetHelpString(), wxMenuItem
@@ -455,7 +455,7 @@ public:
/**
Adds a checkable item to the end of the menu.
@see Append(), InsertCheckItem()
*/
wxMenuItem* AppendCheckItem(int id, const wxString& item,
@@ -465,7 +465,7 @@ public:
Adds a radio item to the end of the menu. All consequent radio items form a
group and when an item in the group is checked, all the others are
automatically unchecked.
@see Append(), InsertRadioItem()
*/
wxMenuItem* AppendRadioItem(int id, const wxString& item,
@@ -473,7 +473,7 @@ public:
/**
Adds a separator to the end of the menu.
@see Append(), InsertSeparator()
*/
wxMenuItem* AppendSeparator();
@@ -494,12 +494,12 @@ public:
/**
Checks or unchecks the menu item.
@param id
The menu item identifier.
@param check
If @true, the item will be checked, otherwise it will be unchecked.
@see IsChecked()
*/
void Check(int id, const bool check);
@@ -509,12 +509,12 @@ public:
Deletes the menu item from the menu. If the item is a submenu, it will
@b not be deleted. Use Destroy() if you want to
delete a submenu.
@param id
Id of the menu item to be deleted.
@param item
Menu item to be deleted.
@see FindItem(), Destroy(), Remove()
*/
void Delete(int id);
@@ -526,12 +526,12 @@ public:
Deletes the menu item from the menu. If the item is a submenu, it will
be deleted. Use Remove() if you want to keep the submenu
(for example, to reuse it later).
@param id
Id of the menu item to be deleted.
@param item
Menu item to be deleted.
@see FindItem(), Deletes(), Remove()
*/
void Destroy(int id);
@@ -540,12 +540,12 @@ public:
/**
Enables or disables (greys out) a menu item.
@param id
The menu item identifier.
@param enable
@true to enable the menu item, @false to disable it.
@see IsEnabled()
*/
void Enable(int id, const bool enable);
@@ -554,7 +554,7 @@ public:
/**
Finds the menu item object associated with the given menu item identifier and,
optionally, the (sub)menu it belongs to.
@param itemString
Menu item string to find.
@param id
@@ -562,10 +562,10 @@ public:
@param menu
If the pointer is not @NULL, it will be filled with the item's
parent menu (if the item was found)
@returns First form: menu item identifier, or wxNOT_FOUND if none is
found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
*/
@@ -580,25 +580,25 @@ public:
/**
Returns the help string associated with a menu item.
@param id
The menu item identifier.
@returns The help string, or the empty string if there is no help string
or the item was not found.
@see SetHelpString(), Append()
*/
wxString GetHelpString(int id) const;
/**
Returns a menu item label.
@param id
The menu item identifier.
@returns The item label, or the empty string if the item was not found.
@see GetLabelText(), SetLabel()
*/
wxString GetLabel(int id) const;
@@ -606,12 +606,12 @@ public:
/**
Returns a menu item label, without any of the original mnemonics and
accelerators.
@param id
The menu item identifier.
@returns The item label, or the empty string if the item was not found.
@see GetLabel(), SetLabel()
*/
wxString GetLabelText(int id) const;
@@ -629,10 +629,10 @@ public:
/**
Returns the title of the menu.
@remarks This is relevant only to popup menus, use
wxMenuBar::GetMenuLabel for the menus in the menubar.
@see SetTitle()
*/
wxString GetTitle() const;
@@ -642,7 +642,7 @@ public:
Inserts the given @a item before the position @e pos. Inserting the item
at position GetMenuItemCount() is the same
as appending it.
@see Append(), Prepend()
*/
wxMenuItem* Insert(size_t pos, wxMenuItem* item);
@@ -654,7 +654,7 @@ public:
/**
Inserts a checkable item at the given position.
@see Insert(), AppendCheckItem()
*/
wxMenuItem* InsertCheckItem(size_t pos, int id,
@@ -663,7 +663,7 @@ public:
/**
Inserts a radio item at the given position.
@see Insert(), AppendRadioItem()
*/
wxMenuItem* InsertRadioItem(size_t pos, int id,
@@ -672,31 +672,31 @@ public:
/**
Inserts a separator at the given position.
@see Insert(), AppendSeparator()
*/
wxMenuItem* InsertSeparator(size_t pos);
/**
Determines whether a menu item is checked.
@param id
The menu item identifier.
@returns @true if the menu item is checked, @false otherwise.
@see Check()
*/
bool IsChecked(int id) const;
/**
Determines whether a menu item is enabled.
@param id
The menu item identifier.
@returns @true if the menu item is enabled, @false otherwise.
@see Enable()
*/
bool IsEnabled(int id) const;
@@ -705,7 +705,7 @@ public:
/**
Inserts the given @a item at position 0, i.e. before all the other
existing items.
@see Append(), Insert()
*/
wxMenuItem* Prepend(wxMenuItem* item);
@@ -716,7 +716,7 @@ public:
/**
Inserts a checkable item at position 0.
@see Prepend(), AppendCheckItem()
*/
wxMenuItem* PrependCheckItem(int id, const wxString& item,
@@ -724,7 +724,7 @@ public:
/**
Inserts a radio item at position 0.
@see Prepend(), AppendRadioItem()
*/
wxMenuItem* PrependRadioItem(int id, const wxString& item,
@@ -732,7 +732,7 @@ public:
/**
Inserts a separator at position 0.
@see Prepend(), AppendSeparator()
*/
wxMenuItem* PrependSeparator();
@@ -742,12 +742,12 @@ public:
Removes the menu item from the menu but doesn't delete the associated C++
object. This allows to reuse the same item later by adding it back to the menu
(especially useful with submenus).
@param id
The identifier of the menu item to remove.
@param item
The menu item to remove.
@returns The item which was detached from the menu.
*/
wxMenuItem* Remove(int id);
@@ -756,37 +756,37 @@ public:
/**
Sets an item's help string.
@param id
The menu item identifier.
@param helpString
The help string to set.
@see GetHelpString()
*/
void SetHelpString(int id, const wxString& helpString);
/**
Sets the label of a menu item.
@param id
The menu item identifier.
@param label
The menu item label to set.
@see Append(), GetLabel()
*/
void SetLabel(int id, const wxString& label);
/**
Sets the title of the menu.
@param title
The title to set.
@remarks This is relevant only to popup menus, use
wxMenuBar::SetLabelTop for the menus in the menubar.
@see GetTitle()
*/
void SetTitle(const wxString& title);

20
interface/menuitem.h
View File

@@ -41,9 +41,9 @@ public:
the menu item is selected) in this parameter.
Finally note that you can e.g. use a stock menu label without using its stock
help string:
that is, stock properties are set independently one from the other.
@param parentMenu
Menu that the menu item belongs to.
@param id
@@ -110,7 +110,7 @@ public:
/**
Returns the text associated with the menu item including any accelerator
characters that were passed to the constructor or SetItemLabel.
@see GetItemLabelText(), GetLabelText()
*/
wxString GetItemLabel() const;
@@ -118,7 +118,7 @@ public:
/**
Returns the text associated with the menu item, without any accelerator
characters.
@see GetItemLabel(), GetLabelText()
*/
wxString GetItemLabelText() const;
@@ -133,7 +133,7 @@ public:
Returns the text associated with the menu item without any accelerator
characters it might contain.
This function is deprecated in favour of GetItemLabelText().
@see GetText(), GetLabelFromText()
*/
wxString GetLabel() const;
@@ -141,10 +141,10 @@ public:
/**
Strips all accelerator characters and mnemonics from the given @e text.
For example,
will return just @c "Hello".
This function is deprecated; please use GetLabelText() instead.
@see GetText(), GetLabel()
*/
static wxString GetLabelFromText(const wxString& text);
@@ -152,9 +152,9 @@ public:
/**
Strips all accelerator characters and mnemonics from the given @e text.
For example,
will return just @c "Hello".
@see GetItemLabelText(), GetItemLabel()
*/
static wxString GetLabelText(const wxString& text);
@@ -187,7 +187,7 @@ public:
Returns the text associated with the menu item, such as it was passed to the
wxMenuItem constructor, i.e. with any accelerator characters it may contain.
This function is deprecated in favour of GetItemLabel().
@see GetLabel(), GetLabelFromText()
*/
wxString GetText() const;

30
interface/mimetype.h
View File

@@ -66,7 +66,7 @@ public:
NB: You won't normally need to use more than one wxMimeTypesManager object in a
program.
@ref ctor() wxMimeTypesManager
@ref dtor() ~wxMimeTypesManager
*/
@@ -101,9 +101,9 @@ public:
default ones which are loaded automatically) containing MIME
information in either mailcap(5) or mime.types(5) format.
ReadMailcap()
ReadMimeTypes()
AddFallbacks()
*/
@@ -125,7 +125,7 @@ public:
If the function is successful, it returns a pointer to the wxFileType object
which @b must be deleted by the caller, otherwise @NULL will be returned.
GetFileTypeFromMimeType()
GetFileTypeFromExtension()
*/
@@ -213,23 +213,23 @@ public:
usage but may be also used by the application directly if, for example, you want
to use some non-default command to open the file.
The function replaces all occurrences of
format specification
with
%s
the full file name
%t
the MIME type
%{param}
the value of the parameter @e param
using the MessageParameters object you pass to it.
If there is no '%s' in the command string (and the string is not empty), it is
assumed that the command reads the data on stdin and so the effect is the same
@@ -332,10 +332,10 @@ public:
there are no other parameters. If you wish to supply additional parameters, you
must derive your own class from MessageParameters and override GetParamValue()
function, for example:
Now you only need to create an object of this class and pass it to, for example,
GetOpenCommand() like this:
@b Windows: As only the file name is used by the program associated with the
given extension anyhow (but no other message parameters), there is no need to
ever derive from MessageParameters class for a Windows-only program.

6
interface/minifram.h
View File

@@ -56,7 +56,7 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent. This may be @NULL. If it is non-@NULL, the frame will
always be displayed on top of the parent window on Windows.
@@ -79,9 +79,9 @@ public:
item,
allowing the application user to set Motif resource values for
individual windows.
@remarks The frame behaves like a normal frame on non-Windows platforms.
@see Create()
*/
wxMiniFrame();

2
interface/module.h
View File

@@ -101,7 +101,7 @@ public:
of the module needed by CLASSINFO(), however errors are
not detected until run-time, instead of compile-time, then.
Note that circular dependencies are detected and result in a fatal error.
@param dep
The class information object for the dependent module.
@param classname

46
interface/msgdlg.h
View File

@@ -23,7 +23,7 @@ class wxMessageDialog : public wxDialog
public:
/**
Constructor. Use ShowModal() to show the dialog.
@param parent
Parent window.
@param message
@@ -32,50 +32,50 @@ public:
The dialog caption.
@param style
A dialog style (bitlist) containing flags chosen from the following:
wxOK
Show an OK button.
wxCANCEL
Show a Cancel button.
wxYES_NO
Show Yes and No buttons.
wxYES_DEFAULT
Used with wxYES_NO, makes Yes button the default - which is the default
behaviour.
wxNO_DEFAULT
Used with wxYES_NO, makes No button the default.
wxICON_EXCLAMATION
Shows an exclamation mark icon.
wxICON_HAND
Shows an error icon.
wxICON_ERROR
Shows an error icon - the same as wxICON_HAND.
wxICON_QUESTION
Shows a question mark icon.
wxICON_INFORMATION
Shows an information (i) icon.
wxSTAY_ON_TOP
The message box stays on top of all other window, even those of the other
applications (Windows only).
@param pos

126
interface/notebook.h
View File

@@ -122,7 +122,7 @@ public:
Constructs a notebook control.
Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
window style.
@param parent
The parent window. Must be non-@NULL.
@param id
@@ -152,7 +152,7 @@ public:
/**
Adds a new page.
The call to this function may generate the page changing events.
@param page
Specifies the new page.
@param text
@@ -161,11 +161,11 @@ public:
Specifies whether the page should be selected.
@param imageId
Specifies the optional image index for the new page.
@returns @true if successful, @false otherwise.
@remarks Do not delete the page, it will be deleted by the notebook.
@see InsertPage()
*/
bool AddPage(wxNotebookPage* page, const wxString& text,
@@ -181,7 +181,7 @@ public:
/**
Sets the image list for the page control and takes ownership of
the list.
@see wxImageList, SetImageList()
*/
void AssignImageList(wxImageList* imageList);
@@ -221,7 +221,7 @@ public:
/**
Returns the associated image list.
@see wxImageList, SetImageList()
*/
wxImageList* GetImageList() const;
@@ -274,70 +274,70 @@ public:
Returns the index of the tab at the specified position or @c wxNOT_FOUND
if none. If @a flags parameter is non-@NULL, the position of the point
inside the tab is returned as well.
@param pt
Specifies the point for the hit test.
@param flags
Return value for detailed information. One of the following values:
wxBK_HITTEST_NOWHERE
There was no tab under this point.
wxBK_HITTEST_ONICON
The point was over an icon (currently wxMSW only).
wxBK_HITTEST_ONLABEL
The point was over a label (currently wxMSW only).
wxBK_HITTEST_ONITEM
The point was over an item, but not on the label or icon.
wxBK_HITTEST_ONPAGE
The point was over a currently selected page, not over any tab. Note that
this flag is present only if wxNOT_FOUND is returned.
@returns Returns the zero-based tab index or wxNOT_FOUND if there is no
tab is at the specified position.
*/
@@ -345,7 +345,7 @@ public:
/**
Inserts a new page at the specified position.
@param index
Specifies the position for the new page.
@param page
@@ -356,11 +356,11 @@ public:
Specifies whether the page should be selected.
@param imageId
Specifies the optional image index for the new page.
@returns @true if successful, @false otherwise.
@remarks Do not delete the page, it will be deleted by the notebook.
@see AddPage()
*/
bool InsertPage(size_t index, wxNotebookPage* page,
@@ -370,7 +370,7 @@ public:
/**
An event handler function, called when the page selection is changed.
@see wxNotebookEvent
*/
void OnSelChange(wxNotebookEvent& event);
@@ -383,7 +383,7 @@ public:
/**
Sets the image list for the page control. It does not take
ownership of the image list, you must delete it yourself.
@see wxImageList, AssignImageList()
*/
void SetImageList(wxImageList* imageList);
@@ -416,7 +416,7 @@ public:
The call to this function generates the page changing events.
This function is deprecated and should not be used in new code. Please use the
ChangeSelection() function instead.
@see GetSelection()
*/
int SetSelection(size_t page);

22
interface/object.h
View File

@@ -107,10 +107,10 @@ public:
memory states.
This function is only defined in debug build and doesn't exist at all if
@c __WXDEBUG__ is not defined.
@param stream
Stream on which to output dump information.
@remarks Currently wxWidgets does not define Dump for derived classes,
but programmers may wish to use it for their own
applications. Be sure to call the Dump member of the
@@ -127,7 +127,7 @@ public:
/**
Returns the @b m_refData pointer.
@see Ref(), UnRef(), wxObject::m_refData, SetRefData(),
wxObjectRefData
*/
@@ -136,11 +136,11 @@ public:
/**
Determines whether this class is a subclass of (or the same class as)
the given class.
@param info
A pointer to a class information object, which may be obtained
by using the CLASSINFO macro.
@returns @true if the class represented by info is the same class as this
one or is derived from it.
*/
@@ -156,14 +156,14 @@ public:
/**
Makes this object refer to the data in @e clone.
@param clone
The object to 'clone'.
@remarks First this function calls UnRef() on itself to decrement
(and perhaps free) the data it is currently referring
to.
@see UnRef(), wxObject::m_refData, SetRefData(),
GetRefData(), wxObjectRefData
*/
@@ -171,7 +171,7 @@ public:
/**
Sets the @b m_refData pointer.
@see Ref(), UnRef(), wxObject::m_refData, GetRefData(),
wxObjectRefData
*/
@@ -181,7 +181,7 @@ public:
Decrements the reference count in the associated data, and if it is zero,
deletes the data.
The @b m_refData member is set to @NULL.
@see Ref(), wxObject::m_refData, SetRefData(),
GetRefData(), wxObjectRefData
*/
@@ -198,7 +198,7 @@ public:
/**
wxObjectRefData* m_refData
Pointer to an object which is the object's reference-counted data.
@see Ref(), UnRef(), SetRefData(),
GetRefData(), wxObjectRefData
*/

8
interface/odcombo.h
View File

@@ -49,7 +49,7 @@ public:
//@{
/**
Constructor, creating and showing a owner-drawn combobox.
@param parent
Parent window. Must not be @NULL.
@param id
@@ -72,7 +72,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxOwnerDrawnComboBox();
@@ -140,7 +140,7 @@ public:
The base class version implements a reasonable default behaviour which consists
in drawing the selected item with the standard background colour and drawing a
border around the item if it is either selected or current.
@remarks flags has the same meaning as with OnDrawItem.
*/
void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
@@ -150,7 +150,7 @@ public:
The derived class may implement this function to actually draw the item
with the given index on the provided DC. If function is not implemented,
the item text is simply drawn, as if the control was a normal combobox.
@param dc
The device context to use for drawing
@param rect

22
interface/palette.h
View File

@@ -38,7 +38,7 @@ public:
/**
Creates a palette from arrays of size @e n, one for each
red, blue or green component.
@param palette
A pointer or reference to the palette to copy.
@param n
@@ -49,7 +49,7 @@ public:
An array of green values.
@param blue
An array of blue values.
@see Create()
*/
wxPalette();
@@ -69,7 +69,7 @@ public:
/**
Creates a palette from arrays of size @e n, one for each
red, blue or green component.
@param n
The number of indices in the palette.
@param red
@@ -78,9 +78,9 @@ public:
An array of green values.
@param blue
An array of blue values.
@returns @true if the creation was successful, @false otherwise.
@see wxPalette()
*/
bool Create(int n, const unsigned char* red,
@@ -94,16 +94,16 @@ public:
/**
Returns a pixel value (index into the palette) for the given RGB values.
@param red
Red value.
@param green
Green value.
@param blue
Blue value.
@returns The nearest palette index or wxNOT_FOUND for unexpected errors.
@see GetRGB()
*/
int GetPixel(unsigned char red, unsigned char green,
@@ -111,7 +111,7 @@ public:
/**
Returns RGB values for a given palette index.
@param pixel
The palette index.
@param red
@@ -120,9 +120,9 @@ public:
Receives the green value.
@param blue
Receives the blue value.
@returns @true if the operation was successful.
@see GetPixel()
*/
bool GetRGB(int pixel, const unsigned char* red,

14
interface/panel.h
View File

@@ -36,7 +36,7 @@ public:
//@{
/**
Constructor.
@param parent
The parent window.
@param id
@@ -54,7 +54,7 @@ public:
Used to associate a name with the window,
allowing the application user to set Motif resource values for
individual dialog boxes.
@see Create()
*/
wxPanel();
@@ -91,24 +91,24 @@ public:
/**
Sends a wxInitDialogEvent, which
in turn transfers data to the dialog via validators.
@see wxInitDialogEvent
*/
void InitDialog();
/**
The default handler for wxEVT_SYS_COLOUR_CHANGED.
@param event
The colour change event.
@remarks Changes the panel's colour to conform to the current settings
(Windows only). Add an event table entry for your panel
class if you wish the behaviour to be different (such
as keeping a user-defined background colour). If you do
override this function, call wxEvent::Skip to propagate
the notification to child windows and controls.
@see wxSysColourChangedEvent
*/
void OnSysColourChanged(wxSysColourChangedEvent& event);
@@ -119,7 +119,7 @@ public:
the focus and TAB logic for controls which usually have child controls.
In practice, if you call this method and the control has at least
one child window, the focus will be given to the child window.
@see wxFocusEvent, wxWindow::SetFocus
*/
virtual void SetFocus();

12
interface/platinfo.h
View File

@@ -41,7 +41,7 @@ public:
/**
Returns @true if the OS version is at least @c major.minor.
@see GetOSMajorVersion(), GetOSMinorVersion(),
CheckToolkitVersion()
*/
@@ -49,7 +49,7 @@ public:
/**
Returns @true if the toolkit version is at least @c major.minor.
@see GetToolkitMajorVersion(),
GetToolkitMinorVersion(), CheckOSVersion()
*/
@@ -101,7 +101,7 @@ public:
Returns the run-time major version of the OS associated with this
wxPlatformInfo instance.
See wxGetOsVersion() for more info.
@see CheckOSVersion()
*/
int GetOSMajorVersion() const;
@@ -110,7 +110,7 @@ public:
Returns the run-time minor version of the OS associated with this
wxPlatformInfo instance.
See wxGetOsVersion() for more info.
@see CheckOSVersion()
*/
int GetOSMinorVersion() const;
@@ -174,7 +174,7 @@ public:
Note that if GetPortId() returns wxPORT_BASE, then this value is zero (unless
externally modified with wxPlatformInfo::SetToolkitVersion); that is, no native toolkit is in use.
See wxAppTraits::GetToolkitVersion for more info.
@see CheckToolkitVersion()
*/
int GetToolkitMajorVersion() const;
@@ -185,7 +185,7 @@ public:
Note that if GetPortId() returns wxPORT_BASE, then this value is zero (unless
externally modified with wxPlatformInfo::SetToolkitVersion); that is, no native toolkit is in use.
See wxAppTraits::GetToolkitVersion for more info.
@see CheckToolkitVersion()
*/
int GetToolkitMinorVersion() const;

2
interface/position.h
View File

@@ -48,7 +48,7 @@ public:
//@{
/**
*/
bool operator ==(const wxPosition& p) const;
const bool operator !=(const wxPosition& p) const;

34
interface/print.h
View File

@@ -52,25 +52,25 @@ public:
Constructor.
The buttons parameter may be a combination of the following, using the bitwise
'or' operator.
wxPREVIEW_PRINT
Create a print button.
wxPREVIEW_NEXT
Create a next page button.
wxPREVIEW_PREVIOUS
Create a previous page button.
wxPREVIEW_ZOOM
Create a zoom control.
wxPREVIEW_DEFAULT
Equivalent to a combination of wxPREVIEW_PREVIOUS, wxPREVIEW_NEXT and
wxPREVIEW_ZOOM.
*/
@@ -354,7 +354,7 @@ public:
/**
Constructor. Pass an optional pointer to a block of print
dialog data, which will be copied to the printer object's local data.
@see wxPrintDialogData, wxPrintData
*/
wxPrinter(wxPrintDialogData* data = NULL);
@@ -375,17 +375,17 @@ public:
wxPrintPreview::Print. These functions
set last error to @b wxPRINTER_NO_ERROR if no error happened.
Returned value is one of the following:
@b wxPRINTER_NO_ERROR
No error happened.
@b wxPRINTER_CANCELLED
The user cancelled printing.
@b wxPRINTER_ERROR
There was an error during printing.
*/
static wxPrinterError GetLastError();

2
interface/printdlg.h
View File

@@ -26,7 +26,7 @@ public:
/**
Constructor. Pass a parent window, and optionally a pointer to a block of print
data, which will be copied to the print dialog's print data.
@see wxPrintDialogData
*/
wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);

22
interface/process.h
View File

@@ -57,7 +57,7 @@ public:
value of @c wxPROCESS_DEFAULT or @c wxPROCESS_REDIRECT. Specifying the
former value has no particular effect while using the latter one is equivalent
to calling Redirect().
@param parent
The event handler parent.
@param id
@@ -97,7 +97,7 @@ public:
/**
Returns @true if the given process exists in the system.
@see Kill(), @ref overview_sampleexec "Exec sample"
*/
static bool Exists(int pid);
@@ -130,7 +130,7 @@ public:
/**
Returns @true if there is data to be read on the child process standard
error stream.
@see IsInputAvailable()
*/
bool IsErrorAvailable() const;
@@ -141,7 +141,7 @@ public:
polling-based code waiting for a better mechanism in future wxWidgets versions.
See the @ref overview_sampleexec "exec sample" for an example of using this
function.
@see IsInputOpened()
*/
bool IsInputAvailable() const;
@@ -153,7 +153,7 @@ public:
/**
Send the specified signal to the given process. Possible signal values are:
@c wxSIGNONE, @c wxSIGKILL and @c wxSIGTERM have the same meaning
under both Unix and Windows but all the other signals are equivalent to
@c wxSIGTERM under Windows.
@@ -162,7 +162,7 @@ public:
process will be killed too. Note that under Unix, for wxKILL_CHILDREN
to work you should have created the process passing wxEXEC_MAKE_GROUP_LEADER.
Returns the element of @c wxKillError enum:
@see Exists(), wxKill(), @ref overview_sampleexec "Exec sample"
*/
static wxKillError Kill(int pid, wxSignal signal = wxSIGNONE,
@@ -170,10 +170,10 @@ public:
/**
It is called when the process with the pid
@param pid finishes.
It raises a wxWidgets event when it isn't overridden.
pid
The pid of the process which has just terminated.
@param status
@@ -191,15 +191,15 @@ public:
object will be destroyed automatically when the child process terminates. This
does mean that the child process should be told to quit before the main program
exits to avoid memory leaks.
@param cmd
The command to execute, including optional arguments.
@param flags
The flags to pass to wxExecute.
NOTE: wxEXEC_SYNC should not be used.
@returns A pointer to new wxProcess object or @NULL on error.
@see wxExecute()
*/
static wxProcess* Open(const wxString& cmd,

Some files were not shown because too many files have changed in this diff Show More