regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
parent
3a65144e7c
commit
e54c96f187
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: access.h
|
||||
// Purpose: documentation for wxAccessible class
|
||||
// Purpose: interface of wxAccessible
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -205,3 +205,4 @@ public:
|
||||
*/
|
||||
void SetWindow(wxWindow* window);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: animate.h
|
||||
// Purpose: documentation for wxAnimationCtrl class
|
||||
// Purpose: interface of wxAnimationCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -32,8 +32,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{animationctrl.png}
|
||||
|
||||
@seealso
|
||||
wxAnimation
|
||||
@see wxAnimation
|
||||
*/
|
||||
class wxAnimationCtrl : public wxControl
|
||||
{
|
||||
@ -150,6 +149,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxAnimation
|
||||
@wxheader{animate.h}
|
||||
@ -162,11 +162,9 @@ public:
|
||||
@category{FIXME}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullAnimation
|
||||
::Objects:, ::wxNullAnimation,
|
||||
|
||||
@seealso
|
||||
wxAnimationCtrl
|
||||
@see wxAnimationCtrl
|
||||
*/
|
||||
class wxAnimation : public wxGDIObject
|
||||
{
|
||||
@ -320,3 +318,17 @@ public:
|
||||
*/
|
||||
wxAnimation operator =(const wxAnimation& brush);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxAnimation Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxAnimation wxNullAnimation;
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: app.h
|
||||
// Purpose: documentation for wxApp class
|
||||
// Purpose: interface of wxApp
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -30,8 +30,7 @@
|
||||
@library{wxbase}
|
||||
@category{appmanagement}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxappoverview "wxApp overview"
|
||||
@see @ref overview_wxappoverview "wxApp overview"
|
||||
*/
|
||||
class wxApp : public wxEvtHandler
|
||||
{
|
||||
@ -95,7 +94,8 @@ public:
|
||||
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().
|
||||
This function is new since wxWidgets version 2.9.0
|
||||
|
||||
@wxsince{2.9.0}
|
||||
*/
|
||||
wxString GetAppDisplayName() const;
|
||||
|
||||
@ -169,7 +169,8 @@ public:
|
||||
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 GetVendorName().
|
||||
This function is new since wxWidgets version 2.9.0
|
||||
|
||||
@wxsince{2.9.0}
|
||||
*/
|
||||
wxString GetVendorDisplayName() const;
|
||||
|
||||
@ -248,7 +249,7 @@ public:
|
||||
|
||||
/**
|
||||
This function is called when an assert failure occurs, i.e. the condition
|
||||
specified in wxASSERT macro evaluated to @false.
|
||||
specified in wxASSERT() macro evaluated to @false.
|
||||
It is only called in debug mode (when @c __WXDEBUG__ is defined) as
|
||||
asserts are not left in the release code at all.
|
||||
The base class version shows the default assert failure dialog box proposing to
|
||||
@ -338,12 +339,12 @@ public:
|
||||
This function may be called if something fatal happens: an unhandled
|
||||
exception under Win32 or a a fatal signal under Unix, for example. However,
|
||||
this will not happen by default: you have to explicitly call
|
||||
wxHandleFatalExceptions to enable this.
|
||||
wxHandleFatalExceptions() to enable this.
|
||||
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
|
||||
@see wxHandleFatalExceptions()
|
||||
*/
|
||||
void OnFatalException();
|
||||
|
||||
@ -581,6 +582,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -607,8 +609,8 @@ void wxVLogVerbose(const char* formatString, va_list argPtr);
|
||||
|
||||
/**
|
||||
This is used in headers to create a forward declaration of the
|
||||
wxGetApp function implemented by
|
||||
wxIMPLEMENT_APP. It creates the declaration
|
||||
wxGetApp() function implemented by
|
||||
wxIMPLEMENT_APP(). It creates the declaration
|
||||
@c className wxGetApp(void).
|
||||
Example:
|
||||
|
||||
@ -637,7 +639,7 @@ void wxVLogWarning(const char* formatString, va_list argPtr);
|
||||
|
||||
//@{
|
||||
/**
|
||||
Like wxLogError, but also
|
||||
Like wxLogError(), but also
|
||||
terminates the program with the exit code 3. Using @e abort() standard
|
||||
function also terminates the program with this exit code.
|
||||
*/
|
||||
@ -677,7 +679,7 @@ bool wxHandleFatalExceptions(bool doIt = true);
|
||||
IMPLEMENT_APP(MyApp)
|
||||
@endcode
|
||||
|
||||
See also DECLARE_APP.
|
||||
See also DECLARE_APP().
|
||||
*/
|
||||
#define IMPLEMENT_APP() /* implementation is private */
|
||||
|
||||
@ -685,7 +687,7 @@ bool wxHandleFatalExceptions(bool doIt = true);
|
||||
Returns the error code from the last system call. This function uses
|
||||
@c errno on Unix platforms and @c GetLastError under Win32.
|
||||
|
||||
@see wxSysErrorMsg, wxLogSysError
|
||||
@see wxSysErrorMsg(), wxLogSysError()
|
||||
*/
|
||||
unsigned long wxSysErrorCode();
|
||||
|
||||
@ -765,15 +767,15 @@ void wxVLogTrace(wxTraceMask mask, const char* formatString,
|
||||
/**
|
||||
Returns the error message corresponding to the given system error code. If
|
||||
@a errCode is 0 (default), the last error code (as returned by
|
||||
wxSysErrorCode) is used.
|
||||
wxSysErrorCode()) is used.
|
||||
|
||||
@see wxSysErrorCode, wxLogSysError
|
||||
@see wxSysErrorCode(), wxLogSysError()
|
||||
*/
|
||||
const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
|
||||
|
||||
/**
|
||||
This function is for use in console (wxBase) programs only. It must be called
|
||||
once for each previous successful call to wxInitialize.
|
||||
once for each previous successful call to wxInitialize().
|
||||
*/
|
||||
void wxUninitialize();
|
||||
|
||||
@ -789,9 +791,9 @@ void wxVLogDebug(const char* formatString, va_list argPtr);
|
||||
|
||||
/**
|
||||
This function doesn't exist in wxWidgets but it is created by using
|
||||
the IMPLEMENT_APP macro. Thus, before using it
|
||||
the IMPLEMENT_APP() macro. Thus, before using it
|
||||
anywhere but in the same module where this macro is used, you must make it
|
||||
available using DECLARE_APP.
|
||||
available using DECLARE_APP().
|
||||
The advantage of using this function compared to directly using the global
|
||||
wxTheApp pointer is that the latter is of type @c wxApp * and so wouldn't
|
||||
allow you to access the functions specific to your application class but not
|
||||
@ -820,17 +822,17 @@ void wxVLogStatus(const char* formatString, va_list argPtr);
|
||||
@c main() function before calling any other wxWidgets functions.
|
||||
If the function returns @false the initialization could not be performed,
|
||||
in this case the library cannot be used and
|
||||
wxUninitialize shouldn't be called neither.
|
||||
wxUninitialize() shouldn't be called neither.
|
||||
This function may be called several times but
|
||||
wxUninitialize must be called for each successful
|
||||
wxUninitialize() must be called for each successful
|
||||
call to this function.
|
||||
*/
|
||||
bool wxInitialize();
|
||||
|
||||
/**
|
||||
This is used in headers to create a forward declaration of the
|
||||
wxGetApp function implemented by
|
||||
IMPLEMENT_APP. It creates the declaration
|
||||
wxGetApp() function implemented by
|
||||
IMPLEMENT_APP(). It creates the declaration
|
||||
@c className wxGetApp(void).
|
||||
Example:
|
||||
|
||||
@ -855,7 +857,7 @@ bool wxYield();
|
||||
on the platform) and the corresponding error message. The second form
|
||||
of this function takes the error code explicitly as the first argument.
|
||||
|
||||
@see wxSysErrorCode, wxSysErrorMsg
|
||||
@see wxSysErrorCode(), wxSysErrorMsg()
|
||||
*/
|
||||
void wxLogSysError(const char* formatString, ... );
|
||||
void wxVLogSysError(const char* formatString,
|
||||
@ -878,7 +880,7 @@ void wxVLogSysError(const char* formatString,
|
||||
function wxApp::CleanUp. For example, if exiting from
|
||||
an MFC application that also uses wxWidgets:
|
||||
|
||||
@see wxEntryStart
|
||||
@see wxEntryStart()
|
||||
*/
|
||||
int wxEntry(int& argc, wxChar** argv);
|
||||
int wxEntry(HINSTANCE hInstance,
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: apptrait.h
|
||||
// Purpose: documentation for wxAppTraits class
|
||||
// Purpose: interface of wxAppTraits
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -25,8 +25,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxappoverview "wxApp overview", wxApp
|
||||
@see @ref overview_wxappoverview "wxApp overview", wxApp
|
||||
*/
|
||||
class wxAppTraits
|
||||
{
|
||||
@ -34,7 +33,7 @@ public:
|
||||
/**
|
||||
Called by wxWidgets to create the default configuration object for the
|
||||
application. The default version creates a registry-based
|
||||
wxRegConfig class under MSW and
|
||||
wxRegConfig() class under MSW and
|
||||
wxFileConfig under all other platforms. The
|
||||
wxApp wxApp::GetAppName and
|
||||
wxApp::GetVendorName methods are used to determine the
|
||||
@ -114,3 +113,4 @@ public:
|
||||
*/
|
||||
virtual bool ShowAssertDialog(const wxString& msg);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: archive.h
|
||||
// Purpose: documentation for wxArchiveInputStream class
|
||||
// Purpose: interface of wxArchiveInputStream
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -23,8 +23,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
|
||||
@see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
|
||||
wxArchiveOutputStream
|
||||
*/
|
||||
class wxArchiveInputStream : public wxFilterInputStream
|
||||
@ -55,6 +54,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxArchiveOutputStream
|
||||
@wxheader{archive.h}
|
||||
@ -70,8 +70,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
|
||||
@see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
|
||||
wxArchiveInputStream
|
||||
*/
|
||||
class wxArchiveOutputStream : public wxFilterOutputStream
|
||||
@ -151,6 +150,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxArchiveEntry
|
||||
@wxheader{archive.h}
|
||||
@ -163,9 +163,8 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
|
||||
"Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
|
||||
@see @ref overview_wxarc "Archive formats such as zip", @ref
|
||||
overview_wxarcgeneric "Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
|
||||
*/
|
||||
class wxArchiveEntry : public wxObject
|
||||
{
|
||||
@ -250,7 +249,7 @@ public:
|
||||
|
||||
//@{
|
||||
/**
|
||||
Sets the notifier for this entry.
|
||||
Sets the notifier() for this entry.
|
||||
Whenever the wxArchiveInputStream updates
|
||||
this entry, it will then invoke the associated
|
||||
notifier's wxArchiveNotifier::OnEntryUpdated
|
||||
@ -265,6 +264,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxArchiveClassFactory
|
||||
@wxheader{archive.h}
|
||||
@ -289,9 +289,8 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
|
||||
"Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory
|
||||
@see @ref overview_wxarc "Archive formats such as zip", @ref
|
||||
overview_wxarcgeneric "Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory
|
||||
*/
|
||||
class wxArchiveClassFactory : public wxObject
|
||||
{
|
||||
@ -401,6 +400,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxArchiveNotifier
|
||||
@wxheader{archive.h}
|
||||
@ -423,9 +423,8 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxarcnoseek "Archives on non-seekable streams", wxArchiveEntry,
|
||||
wxArchiveInputStream, wxArchiveOutputStream
|
||||
@see @ref overview_wxarcnoseek "Archives on non-seekable streams",
|
||||
wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
|
||||
*/
|
||||
class wxArchiveNotifier
|
||||
{
|
||||
@ -437,6 +436,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxArchiveIterator
|
||||
@wxheader{archive.h}
|
||||
@ -535,8 +535,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
|
||||
@see wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
|
||||
*/
|
||||
class wxArchiveIterator
|
||||
{
|
||||
@ -564,3 +563,4 @@ public:
|
||||
wxArchiveIterator operator++(int );
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: arrstr.h
|
||||
// Purpose: documentation for wxArrayString class
|
||||
// Purpose: interface of wxArrayString
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -19,7 +19,7 @@
|
||||
doesn't take more space than a C array @e wxString[] type (wxArrayString
|
||||
uses its knowledge of internals of wxString class to achieve this).
|
||||
|
||||
This class is used in the same way as other dynamic arrays,
|
||||
This class is used in the same way as other dynamic arrays(),
|
||||
except that no @e WX_DEFINE_ARRAY declaration is needed for it. When a
|
||||
string is added or inserted in the array, a copy of the string is created, so
|
||||
the original string may be safely deleted (e.g. if it was a @e wxChar *
|
||||
@ -52,8 +52,7 @@
|
||||
@library{wxbase}
|
||||
@category{containers}
|
||||
|
||||
@seealso
|
||||
wxArray, wxString, @ref overview_wxstringoverview "wxString overview"
|
||||
@see wxArray, wxString, @ref overview_wxstringoverview "wxString overview"
|
||||
*/
|
||||
class wxArrayString : public wxArray
|
||||
{
|
||||
@ -223,6 +222,7 @@ Warning:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -236,7 +236,7 @@ Warning:
|
||||
Note that empty tokens will be generated if there are two or more adjacent
|
||||
separators.
|
||||
|
||||
@see wxJoin
|
||||
@see wxJoin()
|
||||
*/
|
||||
wxArrayString wxSplit(const wxString& str, const wxChar sep,
|
||||
const wxChar escape = '
|
||||
@ -250,7 +250,7 @@ wxArrayString wxSplit(const wxString& str, const wxChar sep,
|
||||
occurrence of @e sep
|
||||
in the strings contained in @a arr before joining them which is necessary
|
||||
in order to be able to recover the original array contents from the string
|
||||
later using wxSplit.
|
||||
later using wxSplit().
|
||||
*/
|
||||
wxString wxJoin(const wxArrayString& arr, const wxChar sep,
|
||||
const wxChar escape = '\');
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: artprov.h
|
||||
// Purpose: documentation for wxArtProvider class
|
||||
// Purpose: interface of wxArtProvider
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -70,7 +70,7 @@
|
||||
is used when
|
||||
requesting a resource from it. The ID is represented by wxArtID type and can
|
||||
have one of these predefined values (you can see bitmaps represented by these
|
||||
constants in the artprov sample):
|
||||
constants in the artprov() sample):
|
||||
|
||||
wxART_ERROR
|
||||
wxART_QUESTION
|
||||
@ -128,8 +128,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
See the artprov sample for an example of wxArtProvider usage.
|
||||
@see See the artprov() sample for an example of wxArtProvider usage.
|
||||
*/
|
||||
class wxArtProvider : public wxObject
|
||||
{
|
||||
@ -161,7 +160,7 @@ public:
|
||||
GetBitmap()
|
||||
returns identical bitmap for different @e client values!
|
||||
|
||||
@see See the artprov sample for an example of wxArtProvider usage.
|
||||
@see See the artprov() sample for an example of wxArtProvider usage.
|
||||
*/
|
||||
|
||||
|
||||
@ -251,7 +250,7 @@ public:
|
||||
is used when
|
||||
requesting a resource from it. The ID is represented by wxArtID type and can
|
||||
have one of these predefined values (you can see bitmaps represented by these
|
||||
constants in the artprov sample):
|
||||
constants in the artprov() sample):
|
||||
|
||||
wxART_ERROR
|
||||
wxART_QUESTION
|
||||
@ -333,3 +332,4 @@ public:
|
||||
*/
|
||||
static bool Remove(wxArtProvider* provider);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: atomic.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: aui/aui.h
|
||||
// Purpose: documentation for wxAuiManager class
|
||||
// Purpose: interface of wxAuiManager
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -49,8 +49,7 @@
|
||||
@library{wxbase}
|
||||
@category{aui}
|
||||
|
||||
@seealso
|
||||
wxAuiPaneInfo, wxAuiDockArt
|
||||
@see wxAuiPaneInfo, wxAuiDockArt
|
||||
*/
|
||||
class wxAuiManager : public wxEvtHandler
|
||||
{
|
||||
@ -258,6 +257,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxAuiPaneInfo
|
||||
@headerfile aui.h wx/aui/aui.h
|
||||
@ -275,8 +275,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{aui}
|
||||
|
||||
@seealso
|
||||
wxAuiManager, wxAuiDockArt
|
||||
@see wxAuiManager, wxAuiDockArt
|
||||
*/
|
||||
class wxAuiPaneInfo
|
||||
{
|
||||
@ -684,3 +683,4 @@ public:
|
||||
*/
|
||||
wxAuiPaneInfo& operator operator=(const wxAuiPaneInfo& c);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: aui/auibook.h
|
||||
// Purpose: documentation for wxAuiNotebook class
|
||||
// Purpose: interface of wxAuiNotebook
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -239,6 +239,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxAuiTabArt
|
||||
@headerfile auibook.h wx/aui/auibook.h
|
||||
@ -340,3 +341,4 @@ public:
|
||||
int ShowWindowList(wxWindow* wnd, const wxArrayString& items,
|
||||
int active_idx);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: aui/dockart.h
|
||||
// Purpose: documentation for wxAuiDockArt class
|
||||
// Purpose: interface of wxAuiDockArt
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -28,8 +28,7 @@
|
||||
@library{wxaui}
|
||||
@category{aui}
|
||||
|
||||
@seealso
|
||||
wxAuiManager, wxAuiPaneInfo
|
||||
@see wxAuiManager, wxAuiPaneInfo
|
||||
*/
|
||||
class wxAuiDockArt
|
||||
{
|
||||
@ -135,3 +134,4 @@ public:
|
||||
*/
|
||||
virtual void SetMetric(int id, int new_val);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: base64.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -13,7 +13,7 @@
|
||||
other ones return the output as wxString. There is no error return for these
|
||||
functions except for the first one which returns @c wxCONV_FAILED if the
|
||||
output buffer is too small. To allocate the buffer of the correct size, use
|
||||
wxBase64EncodedSize or call this function with
|
||||
wxBase64EncodedSize() or call this function with
|
||||
@a dst set to @NULL -- it will then return the necessary buffer size.
|
||||
|
||||
@param dst
|
||||
@ -37,14 +37,14 @@ wxString wxBase64Encode(const wxMemoryBuffer& buf);
|
||||
/**
|
||||
Returns the size of the buffer necessary to contain the data encoded in a
|
||||
base64 string of length @e srcLen. This can be useful for allocating a
|
||||
buffer to be passed to wxBase64Decode.
|
||||
buffer to be passed to wxBase64Decode().
|
||||
*/
|
||||
size_t wxBase64DecodedSize(size_t srcLen);
|
||||
|
||||
/**
|
||||
Returns the length of the string with base64 representation of a buffer of
|
||||
specified size @e len. This can be useful for allocating the buffer passed
|
||||
to wxBase64Encode.
|
||||
to wxBase64Encode().
|
||||
*/
|
||||
size_t wxBase64EncodedSize(size_t len);
|
||||
|
||||
@ -53,7 +53,7 @@ size_t wxBase64EncodedSize(size_t len);
|
||||
These function decode a Base64-encoded string. The first version is a raw
|
||||
decoding function and decodes the data into the provided buffer @a dst of
|
||||
the given size @e dstLen. An error is returned if the buffer is not large
|
||||
enough -- that is not at least wxBase64DecodedSize(srcLen)
|
||||
enough -- that is not at least wxBase64DecodedSize(srcLen)()
|
||||
bytes. The second version allocates memory internally and returns it as
|
||||
wxMemoryBuffer and is recommended for normal use.
|
||||
The first version returns the number of bytes written to the buffer or the
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: bitmap.h
|
||||
// Purpose: documentation for wxBitmapHandler class
|
||||
// Purpose: interface of wxBitmapHandler
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -10,7 +10,7 @@
|
||||
@class wxBitmapHandler
|
||||
@wxheader{bitmap.h}
|
||||
|
||||
Overview
|
||||
Overview()
|
||||
|
||||
This is the base class for implementing bitmap file loading/saving, and bitmap
|
||||
creation from data.
|
||||
@ -24,8 +24,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxBitmap, wxIcon, wxCursor
|
||||
@see wxBitmap, wxIcon, wxCursor
|
||||
*/
|
||||
class wxBitmapHandler : public wxObject
|
||||
{
|
||||
@ -145,6 +144,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxBitmap
|
||||
@wxheader{bitmap.h}
|
||||
@ -156,11 +156,9 @@ public:
|
||||
@category{gdi}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullBitmap
|
||||
::Objects:, ::wxNullBitmap,
|
||||
|
||||
@seealso
|
||||
@ref overview_wxbitmapoverview "wxBitmap overview", @ref
|
||||
@see @ref overview_wxbitmapoverview "wxBitmap overview", @ref
|
||||
overview_supportedbitmapformats "supported bitmap file formats", wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC
|
||||
*/
|
||||
class wxBitmap : public wxGDIObject
|
||||
@ -710,6 +708,20 @@ public:
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBitmap Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBitmap wxNullBitmap;
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMask
|
||||
@wxheader{bitmap.h}
|
||||
@ -724,8 +736,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{gdi}
|
||||
|
||||
@seealso
|
||||
wxBitmap, wxDC::Blit, wxMemoryDC
|
||||
@see wxBitmap, wxDC::Blit, wxMemoryDC
|
||||
*/
|
||||
class wxMask : public wxObject
|
||||
{
|
||||
@ -773,3 +784,4 @@ public:
|
||||
bool Create(const wxBitmap& bitmap, int index);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: bmpbuttn.h
|
||||
// Purpose: documentation for wxBitmapButton class
|
||||
// Purpose: interface of wxBitmapButton
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -11,7 +11,7 @@
|
||||
@wxheader{bmpbuttn.h}
|
||||
|
||||
A bitmap button is a control that contains a bitmap.
|
||||
It may be placed on a @ref overview_wxdialog "dialog box" or panel, or indeed
|
||||
It may be placed on a @ref overview_wxdialog "dialog box" or panel(), or indeed
|
||||
almost any other window.
|
||||
|
||||
@beginStyleTable
|
||||
@ -40,8 +40,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{bitmapbutton.png}
|
||||
|
||||
@seealso
|
||||
wxButton
|
||||
@see wxButton
|
||||
*/
|
||||
class wxBitmapButton : public wxButton
|
||||
{
|
||||
@ -184,7 +183,8 @@ public:
|
||||
|
||||
/**
|
||||
Sets the bitmap to be shown when the mouse is over the button.
|
||||
This function is new since wxWidgets version 2.7.0 and the hover bitmap is
|
||||
|
||||
@wxsince{2.7.0} and the hover bitmap is
|
||||
currently only supported in wxMSW.
|
||||
|
||||
@see GetBitmapHover()
|
||||
@ -212,3 +212,4 @@ public:
|
||||
*/
|
||||
void SetBitmapSelected(const wxBitmap& bitmap);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: bmpcbox.h
|
||||
// Purpose: documentation for wxBitmapComboBox class
|
||||
// Purpose: interface of wxBitmapComboBox
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -43,8 +43,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{bitmapcombobox.png}
|
||||
|
||||
@seealso
|
||||
wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent
|
||||
@see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent
|
||||
*/
|
||||
class wxBitmapComboBox : public wxComboBox
|
||||
{
|
||||
@ -171,3 +170,4 @@ public:
|
||||
*/
|
||||
void SetItemBitmap(unsigned int n, const wxBitmap& bitmap);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: brush.h
|
||||
// Purpose: documentation for wxBrush class
|
||||
// Purpose: interface of wxBrush
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -18,31 +18,10 @@
|
||||
@category{gdi}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullBrush
|
||||
Pointers:
|
||||
wxBLUE_BRUSH
|
||||
::Objects:, ::wxNullBrush, ::Pointers:, ::wxBLUE_BRUSH, ::wxGREEN_BRUSH,
|
||||
::wxWHITE_BRUSH, ::wxBLACK_BRUSH, ::wxGREY_BRUSH, ::wxMEDIUM_GREY_BRUSH, ::wxLIGHT_GREY_BRUSH, ::wxTRANSPARENT_BRUSH, ::wxCYAN_BRUSH, ::wxRED_BRUSH,
|
||||
|
||||
wxGREEN_BRUSH
|
||||
|
||||
wxWHITE_BRUSH
|
||||
|
||||
wxBLACK_BRUSH
|
||||
|
||||
wxGREY_BRUSH
|
||||
|
||||
wxMEDIUM_GREY_BRUSH
|
||||
|
||||
wxLIGHT_GREY_BRUSH
|
||||
|
||||
wxTRANSPARENT_BRUSH
|
||||
|
||||
wxCYAN_BRUSH
|
||||
|
||||
wxRED_BRUSH
|
||||
|
||||
@seealso
|
||||
wxBrushList, wxDC, wxDC::SetBrush
|
||||
@see wxBrushList, wxDC, wxDC::SetBrush
|
||||
*/
|
||||
class wxBrush : public wxGDIObject
|
||||
{
|
||||
@ -432,3 +411,73 @@ public:
|
||||
*/
|
||||
bool operator ==(const wxBrush& brush);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxNullBrush;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush Pointers:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxBLUE_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxGREEN_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxWHITE_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxBLACK_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxGREY_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxMEDIUM_GREY_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxLIGHT_GREY_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxTRANSPARENT_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxCYAN_BRUSH;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxBrush wxRED_BRUSH;
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: buffer.h
|
||||
// Purpose: documentation for wxMemoryBuffer class
|
||||
// Purpose: interface of wxMemoryBuffer
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -110,3 +110,4 @@ public:
|
||||
*/
|
||||
void UngetWriteBuf(size_t sizeUsed);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: busyinfo.h
|
||||
// Purpose: documentation for wxBusyInfo class
|
||||
// Purpose: interface of wxBusyInfo
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -70,3 +70,4 @@ public:
|
||||
*/
|
||||
~wxBusyInfo();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: button.h
|
||||
// Purpose: documentation for wxButton class
|
||||
// Purpose: interface of wxButton
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -12,7 +12,7 @@
|
||||
|
||||
A button is a control that contains a text string,
|
||||
and is one of the most common elements of a GUI. It may be placed on a
|
||||
@ref overview_wxdialog "dialog box" or panel, or indeed
|
||||
@ref overview_wxdialog "dialog box" or panel(), or indeed
|
||||
almost any other window.
|
||||
|
||||
@beginStyleTable
|
||||
@ -41,8 +41,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{button.png}
|
||||
|
||||
@seealso
|
||||
wxBitmapButton
|
||||
@see wxBitmapButton
|
||||
*/
|
||||
class wxButton : public wxControl
|
||||
{
|
||||
@ -140,3 +139,4 @@ public:
|
||||
*/
|
||||
void SetLabel(const wxString& label);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: calctrl.h
|
||||
// Purpose: documentation for wxCalendarEvent class
|
||||
// Purpose: interface of wxCalendarEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -16,8 +16,7 @@
|
||||
@library{wxadv}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxCalendarCtrl
|
||||
@see wxCalendarCtrl
|
||||
*/
|
||||
class wxCalendarEvent : public wxDateEvent
|
||||
{
|
||||
@ -37,6 +36,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCalendarDateAttr
|
||||
@wxheader{calctrl.h}
|
||||
@ -47,8 +47,7 @@ public:
|
||||
@library{wxadv}
|
||||
@category{misc}
|
||||
|
||||
@seealso
|
||||
wxCalendarCtrl
|
||||
@see wxCalendarCtrl
|
||||
*/
|
||||
class wxCalendarDateAttr
|
||||
{
|
||||
@ -73,7 +72,7 @@ public:
|
||||
const wxColour GetBackgroundColour() const;
|
||||
|
||||
/**
|
||||
Returns the border to use for the item with this attribute.
|
||||
Returns the border() to use for the item with this attribute.
|
||||
*/
|
||||
wxCalendarDateBorder GetBorder() const;
|
||||
|
||||
@ -156,6 +155,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCalendarCtrl
|
||||
@wxheader{calctrl.h}
|
||||
@ -208,8 +208,7 @@ public:
|
||||
@category{ctrl}
|
||||
@appearance{calendarctrl.png}
|
||||
|
||||
@seealso
|
||||
@ref overview_samplecalendar "Calendar sample", wxCalendarDateAttr,
|
||||
@see @ref overview_samplecalendar "Calendar sample", wxCalendarDateAttr,
|
||||
wxCalendarEvent
|
||||
*/
|
||||
class wxCalendarCtrl : public wxControl
|
||||
@ -321,7 +320,7 @@ public:
|
||||
|
||||
/**
|
||||
Returns one of @c wxCAL_HITTEST_XXX
|
||||
constants and fills either @a date or
|
||||
constants() and fills either @a date or
|
||||
@a wd pointer with the corresponding value depending on the hit test code.
|
||||
*/
|
||||
wxCalendarHitTestResult HitTest(const wxPoint& pos,
|
||||
@ -369,3 +368,4 @@ public:
|
||||
void SetHolidayColours(const wxColour& colFg,
|
||||
const wxColour& colBg);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: caret.h
|
||||
// Purpose: documentation for wxCaret class
|
||||
// Purpose: interface of wxCaret
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -24,8 +24,7 @@
|
||||
@library{wxcore}
|
||||
@category{misc}
|
||||
|
||||
@seealso
|
||||
wxCaret::GetBlinkTime
|
||||
@see wxCaret::GetBlinkTime
|
||||
*/
|
||||
class wxCaret
|
||||
{
|
||||
@ -145,3 +144,4 @@ public:
|
||||
*/
|
||||
void Show(bool show = true);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: chartype.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -38,7 +38,7 @@ const wxChar* wxT(const char* s);
|
||||
current build, but using it can be beneficial in performance-sensitive code to
|
||||
do the conversion at compile-time instead.
|
||||
|
||||
@see wxT
|
||||
@see wxT()
|
||||
*/
|
||||
wxStringCharType wxS(char ch);
|
||||
const wxStringCharType* wxS(const char* s);
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: checkbox.h
|
||||
// Purpose: documentation for wxCheckBox class
|
||||
// Purpose: interface of wxCheckBox
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -39,8 +39,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{checkbox.png}
|
||||
|
||||
@seealso
|
||||
wxRadioButton, wxCommandEvent
|
||||
@see wxRadioButton, wxCommandEvent
|
||||
*/
|
||||
class wxCheckBox : public wxControl
|
||||
{
|
||||
@ -148,3 +147,4 @@ public:
|
||||
*/
|
||||
void SetValue(bool state);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: checklst.h
|
||||
// Purpose: documentation for wxCheckListBox class
|
||||
// Purpose: interface of wxCheckListBox
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -30,8 +30,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{checklistbox.png}
|
||||
|
||||
@seealso
|
||||
wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
|
||||
@see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
|
||||
*/
|
||||
class wxCheckListBox : public wxListBox
|
||||
{
|
||||
@ -95,3 +94,4 @@ public:
|
||||
*/
|
||||
void Check(int item, bool check = true);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: choicdlg.h
|
||||
// Purpose: documentation for wxMultiChoiceDialog class
|
||||
// Purpose: interface of wxMultiChoiceDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -16,8 +16,7 @@
|
||||
@library{wxbase}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
|
||||
@see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
|
||||
wxSingleChoiceDialog
|
||||
*/
|
||||
class wxMultiChoiceDialog : public wxDialog
|
||||
@ -118,6 +117,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSingleChoiceDialog
|
||||
@wxheader{choicdlg.h}
|
||||
@ -129,9 +129,8 @@ public:
|
||||
@library{wxbase}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog overview",
|
||||
wxMultiChoiceDialog
|
||||
@see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog
|
||||
overview", wxMultiChoiceDialog
|
||||
*/
|
||||
class wxSingleChoiceDialog : public wxDialog
|
||||
{
|
||||
@ -246,6 +245,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -281,7 +281,7 @@ int wxGetSingleChoiceIndex(const wxString& message,
|
||||
Pops up a dialog box containing a message, OK/Cancel buttons and a
|
||||
single-selection listbox. The user may choose an item and press OK to return a
|
||||
string or Cancel to return the empty string. Use
|
||||
wxGetSingleChoiceIndex if empty string is a
|
||||
wxGetSingleChoiceIndex() if empty string is a
|
||||
valid choice and if you want to be able to detect pressing Cancel reliably.
|
||||
You may pass the list of strings to choose from either using @e choices
|
||||
which is an array of @a n strings for the listbox or by using a single
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: choice.h
|
||||
// Purpose: documentation for wxChoice class
|
||||
// Purpose: interface of wxChoice
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{choice.png}
|
||||
|
||||
@seealso
|
||||
wxListBox, wxComboBox, wxCommandEvent
|
||||
@see wxListBox, wxComboBox, wxCommandEvent
|
||||
*/
|
||||
class wxChoice : public wxControlWithItems
|
||||
{
|
||||
@ -118,7 +117,8 @@ 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.
|
||||
This function is new since wxWidgets version 2.6.2 (before this version
|
||||
|
||||
@wxsince{2.6.2} (before this version
|
||||
wxControlWithItems::GetSelection itself behaved like
|
||||
this).
|
||||
*/
|
||||
@ -132,3 +132,4 @@ public:
|
||||
*/
|
||||
void SetColumns(int n = 1);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: choicebk.h
|
||||
// Purpose: documentation for wxChoicebook class
|
||||
// Purpose: interface of wxChoicebook
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -42,8 +42,7 @@
|
||||
@library{wxcore}
|
||||
@category{miscwnd}
|
||||
|
||||
@seealso
|
||||
wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample"
|
||||
@see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample"
|
||||
*/
|
||||
class wxChoicebook : public wxBookCtrl overview
|
||||
{
|
||||
@ -60,3 +59,4 @@ public:
|
||||
const wxString& name = wxEmptyStr);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: clipboard.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: clipbrd.h
|
||||
// Purpose: documentation for wxClipboard class
|
||||
// Purpose: interface of wxClipboard
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -56,8 +56,7 @@
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview, wxDataObject
|
||||
@see @ref overview_wxdndoverview, wxDataObject
|
||||
*/
|
||||
class wxClipboard : public wxObject
|
||||
{
|
||||
@ -162,3 +161,4 @@ public:
|
||||
*/
|
||||
void UsePrimarySelection(bool primary = true);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: clntdata.h
|
||||
// Purpose: documentation for wxClientDataContainer class
|
||||
// Purpose: interface of wxClientDataContainer
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -24,8 +24,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxEvtHandler, wxClientData
|
||||
@see wxEvtHandler, wxClientData
|
||||
*/
|
||||
class wxClientDataContainer
|
||||
{
|
||||
@ -62,6 +61,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxClientData
|
||||
@wxheader{clntdata.h}
|
||||
@ -92,8 +92,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxEvtHandler, wxTreeItemData, wxStringClientData, wxClientDataContainer
|
||||
@see wxEvtHandler, wxTreeItemData, wxStringClientData, wxClientDataContainer
|
||||
*/
|
||||
class wxClientData
|
||||
{
|
||||
@ -110,6 +109,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxStringClientData
|
||||
@wxheader{clntdata.h}
|
||||
@ -140,3 +140,4 @@ public:
|
||||
*/
|
||||
void SetData(const wxString& data);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: clrpicker.h
|
||||
// Purpose: documentation for wxColourPickerCtrl class
|
||||
// Purpose: interface of wxColourPickerCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -35,8 +35,7 @@
|
||||
@category{miscpickers}
|
||||
@appearance{colourpickerctrl.png}
|
||||
|
||||
@seealso
|
||||
wxColourDialog, wxColourPickerEvent
|
||||
@see wxColourDialog, wxColourPickerEvent
|
||||
*/
|
||||
class wxColourPickerCtrl : public wxPickerBase
|
||||
{
|
||||
@ -97,6 +96,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxColourPickerEvent
|
||||
@wxheader{clrpicker.h}
|
||||
@ -107,8 +107,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxColourPickerCtrl
|
||||
@see wxColourPickerCtrl
|
||||
*/
|
||||
class wxColourPickerEvent : public wxCommandEvent
|
||||
{
|
||||
@ -129,3 +128,4 @@ public:
|
||||
*/
|
||||
void SetColour(const wxColour& pos);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cmdline.h
|
||||
// Purpose: documentation for wxCmdLineParser class
|
||||
// Purpose: interface of wxCmdLineParser
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -58,8 +58,7 @@
|
||||
@library{wxbase}
|
||||
@category{appmanagement}
|
||||
|
||||
@seealso
|
||||
wxApp::argc and wxApp::argv, console sample
|
||||
@see wxApp::argc and wxApp::argv, console sample
|
||||
*/
|
||||
class wxCmdLineParser
|
||||
{
|
||||
@ -289,3 +288,4 @@ public:
|
||||
*/
|
||||
void Usage();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cmdproc.h
|
||||
// Purpose: documentation for wxCommand class
|
||||
// Purpose: interface of wxCommand
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -18,8 +18,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
Overview
|
||||
@see Overview()
|
||||
*/
|
||||
class wxCommand : public wxObject
|
||||
{
|
||||
@ -81,6 +80,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCommandProcessor
|
||||
@wxheader{cmdproc.h}
|
||||
@ -92,8 +92,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxcommandprocessoroverview "wxCommandProcessor overview",
|
||||
@see @ref overview_wxcommandprocessoroverview "wxCommandProcessor overview",
|
||||
wxCommand
|
||||
*/
|
||||
class wxCommandProcessor : public wxObject
|
||||
@ -226,3 +225,4 @@ public:
|
||||
*/
|
||||
virtual bool Undo();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cmndata.h
|
||||
// Purpose: documentation for wxFontData class
|
||||
// Purpose: interface of wxFontData
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -17,8 +17,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
Overview, wxFont, wxFontDialog
|
||||
@see Overview(), wxFont, wxFontDialog
|
||||
*/
|
||||
class wxFontData : public wxObject
|
||||
{
|
||||
@ -120,6 +119,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPageSetupDialogData
|
||||
@wxheader{cmndata.h}
|
||||
@ -133,8 +133,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{printing}
|
||||
|
||||
@seealso
|
||||
@ref overview_printingoverview "Printing framework overview", wxPageSetupDialog
|
||||
@see @ref overview_printingoverview "Printing framework overview",
|
||||
wxPageSetupDialog
|
||||
*/
|
||||
class wxPageSetupDialogData : public wxObject
|
||||
{
|
||||
@ -332,6 +332,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxColourData
|
||||
@wxheader{cmndata.h}
|
||||
@ -341,9 +342,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview "wxColourDialog
|
||||
overview"
|
||||
@see wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview
|
||||
"wxColourDialog overview"
|
||||
*/
|
||||
class wxColourData : public wxObject
|
||||
{
|
||||
@ -411,6 +411,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPrintData
|
||||
@wxheader{cmndata.h}
|
||||
@ -424,9 +425,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{printing}
|
||||
|
||||
@seealso
|
||||
@ref overview_printingoverview "Printing framework overview", wxPrintDialog,
|
||||
wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC
|
||||
@see @ref overview_printingoverview "Printing framework overview",
|
||||
wxPrintDialog, wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC
|
||||
*/
|
||||
class wxPrintData : public wxObject
|
||||
{
|
||||
@ -575,6 +575,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPrintDialogData
|
||||
@wxheader{cmndata.h}
|
||||
@ -586,9 +587,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{printing}
|
||||
|
||||
@seealso
|
||||
@ref overview_printingoverview "Printing framework overview", wxPrintDialog,
|
||||
@ref overview_wxprintdialogoverview "wxPrintDialog Overview"
|
||||
@see @ref overview_printingoverview "Printing framework overview",
|
||||
wxPrintDialog, @ref overview_wxprintdialogoverview "wxPrintDialog Overview"
|
||||
*/
|
||||
class wxPrintDialogData : public wxObject
|
||||
{
|
||||
@ -748,3 +748,4 @@ public:
|
||||
void operator =(const wxPrintDialogData& data);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: collpane.h
|
||||
// Purpose: documentation for wxCollapsiblePaneEvent class
|
||||
// Purpose: interface of wxCollapsiblePaneEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -16,8 +16,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxCollapsiblePane
|
||||
@see wxCollapsiblePane
|
||||
*/
|
||||
class wxCollapsiblePaneEvent : public wxCommandEvent
|
||||
{
|
||||
@ -42,6 +41,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCollapsiblePane
|
||||
@wxheader{collpane.h}
|
||||
@ -96,8 +96,7 @@ public:
|
||||
@category{ctrl}
|
||||
@appearance{collapsiblepane.png}
|
||||
|
||||
@seealso
|
||||
wxPanel, wxCollapsiblePaneEvent
|
||||
@see wxPanel, wxCollapsiblePaneEvent
|
||||
*/
|
||||
class wxCollapsiblePane : public wxControl
|
||||
{
|
||||
@ -170,3 +169,4 @@ public:
|
||||
*/
|
||||
bool IsExpanded() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: colordlg.h
|
||||
// Purpose: documentation for wxColourDialog class
|
||||
// Purpose: interface of wxColourDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,9 +15,8 @@
|
||||
@library{wxcore}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
|
||||
wxColourData, wxGetColourFromUser
|
||||
@see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
|
||||
wxColourData, wxGetColourFromUser()
|
||||
*/
|
||||
class wxColourDialog : public wxDialog
|
||||
{
|
||||
@ -58,6 +57,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: colour.h
|
||||
// Purpose: documentation for wxColour class
|
||||
// Purpose: interface of wxColour
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -24,25 +24,10 @@
|
||||
@category{gdi}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullColour
|
||||
Pointers:
|
||||
wxBLACK
|
||||
::Objects:, ::wxNullColour, ::Pointers:, ::wxBLACK, ::wxWHITE, ::wxRED,
|
||||
::wxBLUE, ::wxGREEN, ::wxCYAN, ::wxLIGHT_GREY,
|
||||
|
||||
wxWHITE
|
||||
|
||||
wxRED
|
||||
|
||||
wxBLUE
|
||||
|
||||
wxGREEN
|
||||
|
||||
wxCYAN
|
||||
|
||||
wxLIGHT_GREY
|
||||
|
||||
@seealso
|
||||
wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
|
||||
@see wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
|
||||
*/
|
||||
class wxColour : public wxObject
|
||||
{
|
||||
@ -90,7 +75,8 @@ public:
|
||||
/**
|
||||
is not
|
||||
specified in flags.
|
||||
This function is new since wxWidgets version 2.7.0
|
||||
|
||||
@wxsince{2.7.0}
|
||||
*/
|
||||
wxString GetAsString(long flags);
|
||||
const wxC2S_NAME, to obtain the colour name (e.g.
|
||||
@ -133,12 +119,13 @@ public:
|
||||
Sets the RGB intensity values using the given values (first overload),
|
||||
extracting them from the packed long (second overload), using the given string (third overloard).
|
||||
When using third form, Set() accepts: colour names (those listed in
|
||||
wxTheColourDatabase), the CSS-like
|
||||
wxTheColourDatabase()), the CSS-like
|
||||
@c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax (case insensitive)
|
||||
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.
|
||||
This function is new since wxWidgets version 2.7.0
|
||||
|
||||
@wxsince{2.7.0}
|
||||
*/
|
||||
void Set(unsigned char red, unsigned char green,
|
||||
unsigned char blue,
|
||||
@ -169,3 +156,58 @@ public:
|
||||
*/
|
||||
bool operator ==(const wxColour& colour);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxNullColour;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour Pointers:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxBLACK;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxWHITE;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxRED;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxBLUE;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxGREEN;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxCYAN;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxColour wxLIGHT_GREY;
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: combo.h
|
||||
// Purpose: documentation for wxComboPopup class
|
||||
// Purpose: interface of wxComboPopup
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -18,8 +18,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxComboCtrl
|
||||
@see wxComboCtrl
|
||||
*/
|
||||
class wxComboPopup
|
||||
{
|
||||
@ -144,6 +143,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxComboCtrl
|
||||
@wxheader{combo.h}
|
||||
@ -184,8 +184,7 @@ public:
|
||||
@category{ctrl}
|
||||
@appearance{comboctrl.png}
|
||||
|
||||
@seealso
|
||||
wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, wxCommandEvent
|
||||
@see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, wxCommandEvent
|
||||
*/
|
||||
class wxComboCtrl : public wxControl
|
||||
{
|
||||
@ -622,3 +621,4 @@ public:
|
||||
*/
|
||||
void UseAltPopupWindow(bool enable = true);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: combobox.h
|
||||
// Purpose: documentation for wxComboBox class
|
||||
// Purpose: interface of wxComboBox
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -58,8 +58,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{combobox.png}
|
||||
|
||||
@seealso
|
||||
wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
|
||||
@see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
|
||||
*/
|
||||
class wxComboBox : public wxControlWithItems
|
||||
{
|
||||
@ -289,3 +288,4 @@ public:
|
||||
*/
|
||||
void Undo();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: config.h
|
||||
// Purpose: documentation for wxConfigBase class
|
||||
// Purpose: interface of wxConfigBase
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -83,7 +83,8 @@ public:
|
||||
flag, which changes the default local configuration file to
|
||||
~/.appname/appname
|
||||
should be used. Notice that this flag is ignored if localFilename is
|
||||
provided. This function is new since wxWidgets version 2.8.2
|
||||
provided.
|
||||
@wxsince{2.8.2}
|
||||
For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which
|
||||
will turn off character escaping for the values of entries stored in the
|
||||
config
|
||||
@ -299,8 +300,8 @@ public:
|
||||
Currently, supported types of data are:
|
||||
wxString, @e long, @e double, @e bool,
|
||||
wxColour and any other types,
|
||||
for which functions wxToString
|
||||
and wxFromString are defined.
|
||||
for which functions wxToString()
|
||||
and wxFromString() are defined.
|
||||
Try not to read long values into string variables and vice versa: although it
|
||||
just might work with wxFileConfig, you will get a system error with
|
||||
wxRegConfig because in the Windows registry the different types of entries are
|
||||
@ -377,7 +378,7 @@ public:
|
||||
//@{
|
||||
/**
|
||||
Reads a value of type T, for which function
|
||||
wxFromString is defined,
|
||||
wxFromString() is defined,
|
||||
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;
|
||||
@ -440,7 +441,7 @@ public:
|
||||
|
||||
/**
|
||||
Reads a value of type T, for which function
|
||||
wxFromString is defined, from the key and returns it.
|
||||
wxFromString() is defined, from the key and returns it.
|
||||
@a defaultVal is returned if the key is not found.
|
||||
*/
|
||||
T ReadObject(const wxString& key, T const& defaultVal) const;
|
||||
@ -548,7 +549,7 @@ public:
|
||||
//@{
|
||||
/**
|
||||
These functions write the specified value to the config file and return @true
|
||||
on success. In the last one, function wxToString must be
|
||||
on success. In the last one, function wxToString() must be
|
||||
defined for type @e T.
|
||||
|
||||
|
||||
@ -576,3 +577,4 @@ public:
|
||||
bool Write(const wxString& key, const T& buf);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: control.h
|
||||
// Purpose: documentation for wxControl class
|
||||
// Purpose: interface of wxControl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -19,8 +19,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{control.png}
|
||||
|
||||
@seealso
|
||||
wxValidator
|
||||
@see wxValidator
|
||||
*/
|
||||
class wxControl : public wxWindow
|
||||
{
|
||||
@ -58,3 +57,4 @@ public:
|
||||
*/
|
||||
void SetLabel(const wxString& label);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: convauto.h
|
||||
// Purpose: documentation for wxConvAuto class
|
||||
// Purpose: interface of wxConvAuto
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -42,8 +42,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_mbconvclasses "wxMBConv classes overview"
|
||||
@see @ref overview_mbconvclasses "wxMBConv classes overview"
|
||||
*/
|
||||
class wxConvAuto : public wxMBConv
|
||||
{
|
||||
@ -95,3 +94,4 @@ public:
|
||||
*/
|
||||
static void SetFallbackEncoding(wxFontEncoding enc);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cpp.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -24,16 +24,16 @@ Returns the string representation of the given symbol which can be either a
|
||||
literal or a macro (hence the advantage of using this macro instead of the
|
||||
standard preprocessor @c # operator which doesn't work with macros).
|
||||
Notice that this macro always produces a @c char string, use
|
||||
wxSTRINGIZE_T to build a wide string Unicode build.
|
||||
wxSTRINGIZE_T() to build a wide string Unicode build.
|
||||
|
||||
@see wxCONCAT
|
||||
@see wxCONCAT()
|
||||
*/
|
||||
#define wxSTRINGIZE(x) /* implementation is private */
|
||||
|
||||
/**
|
||||
Returns the string representation of the given symbol as either an ASCII or
|
||||
Unicode string, depending on the current build. This is the Unicode-friendly
|
||||
equivalent of wxSTRINGIZE.
|
||||
equivalent of wxSTRINGIZE().
|
||||
*/
|
||||
#define wxSTRINGIZE_T(x) /* implementation is private */
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cshelp.h
|
||||
// Purpose: documentation for wxHelpProvider class
|
||||
// Purpose: interface of wxHelpProvider
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -20,8 +20,7 @@
|
||||
@library{wxcore}
|
||||
@category{help}
|
||||
|
||||
@seealso
|
||||
wxContextHelp, wxContextHelpButton, wxSimpleHelpProvider,
|
||||
@see wxContextHelp, wxContextHelpButton, wxSimpleHelpProvider,
|
||||
wxHelpControllerHelpProvider, wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint
|
||||
*/
|
||||
class wxHelpProvider
|
||||
@ -98,6 +97,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxHelpControllerHelpProvider
|
||||
@wxheader{cshelp.h}
|
||||
@ -119,9 +119,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{help}
|
||||
|
||||
@seealso
|
||||
wxHelpProvider, wxSimpleHelpProvider, wxContextHelp, wxWindow::SetHelpText,
|
||||
wxWindow::GetHelpTextAtPoint
|
||||
@see wxHelpProvider, wxSimpleHelpProvider, wxContextHelp,
|
||||
wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint
|
||||
*/
|
||||
class wxHelpControllerHelpProvider : public wxSimpleHelpProvider
|
||||
{
|
||||
@ -144,6 +143,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxContextHelp
|
||||
@wxheader{cshelp.h}
|
||||
@ -180,8 +180,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{help}
|
||||
|
||||
@seealso
|
||||
wxHelpEvent, wxHelpController, wxContextHelpButton
|
||||
@see wxHelpEvent, wxHelpController, wxContextHelpButton
|
||||
*/
|
||||
class wxContextHelp : public wxObject
|
||||
{
|
||||
@ -214,6 +213,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxContextHelpButton
|
||||
@wxheader{cshelp.h}
|
||||
@ -232,8 +232,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{help}
|
||||
|
||||
@seealso
|
||||
wxBitmapButton, wxContextHelp
|
||||
@see wxBitmapButton, wxContextHelp
|
||||
*/
|
||||
class wxContextHelpButton : public wxBitmapButton
|
||||
{
|
||||
@ -265,6 +264,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSimpleHelpProvider
|
||||
@wxheader{cshelp.h}
|
||||
@ -276,8 +276,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{help}
|
||||
|
||||
@seealso
|
||||
wxHelpProvider, wxHelpControllerHelpProvider, wxContextHelp,
|
||||
@see wxHelpProvider, wxHelpControllerHelpProvider, wxContextHelp,
|
||||
wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint
|
||||
*/
|
||||
class wxSimpleHelpProvider : public wxHelpProvider
|
||||
@ -285,3 +284,4 @@ class wxSimpleHelpProvider : public wxHelpProvider
|
||||
public:
|
||||
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: ctrlsub.h
|
||||
// Purpose: documentation for wxControlWithItems class
|
||||
// Purpose: interface of wxControlWithItems
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -35,8 +35,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxControlWithItems::Clear
|
||||
@see wxControlWithItems::Clear
|
||||
*/
|
||||
class wxControlWithItems : public wxControl
|
||||
{
|
||||
@ -333,3 +332,4 @@ public:
|
||||
*/
|
||||
bool SetStringSelection(const wxString& string);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cursor.h
|
||||
// Purpose: documentation for wxCursor class
|
||||
// Purpose: interface of wxCursor
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -28,17 +28,10 @@
|
||||
@category{gdi}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullCursor
|
||||
Pointers:
|
||||
wxSTANDARD_CURSOR
|
||||
::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR,
|
||||
::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR,
|
||||
|
||||
wxHOURGLASS_CURSOR
|
||||
|
||||
wxCROSS_CURSOR
|
||||
|
||||
@seealso
|
||||
wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
|
||||
@see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
|
||||
*/
|
||||
class wxCursor : public wxBitmap
|
||||
{
|
||||
@ -467,3 +460,38 @@ public:
|
||||
*/
|
||||
wxCursor operator =(const wxCursor& cursor);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor wxNullCursor;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor Pointers:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor wxSTANDARD_CURSOR;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor wxHOURGLASS_CURSOR;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxCursor wxCROSS_CURSOR;
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dataobj.h
|
||||
// Purpose: documentation for wxCustomDataObject class
|
||||
// Purpose: interface of wxCustomDataObject
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -30,8 +30,7 @@
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
wxDataObject
|
||||
@see wxDataObject
|
||||
*/
|
||||
class wxCustomDataObject : public wxDataObjectSimple
|
||||
{
|
||||
@ -91,6 +90,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataObjectComposite
|
||||
@wxheader{dataobj.h}
|
||||
@ -111,8 +111,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxBitmapDataObject
|
||||
*/
|
||||
class wxDataObjectComposite : public wxDataObject
|
||||
@ -139,6 +138,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataObjectSimple
|
||||
@wxheader{dataobj.h}
|
||||
@ -162,8 +162,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject
|
||||
*/
|
||||
class wxDataObjectSimple : public wxDataObject
|
||||
@ -208,6 +207,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxBitmapDataObject
|
||||
@wxheader{dataobj.h}
|
||||
@ -227,8 +227,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxDataObject
|
||||
*/
|
||||
class wxBitmapDataObject : public wxDataObjectSimple
|
||||
@ -257,6 +256,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataFormat
|
||||
@wxheader{dataobj.h}
|
||||
@ -331,8 +331,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
overview_samplednd "DnD sample", wxDataObject
|
||||
*/
|
||||
class wxDataFormat
|
||||
@ -377,6 +376,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxURLDataObject
|
||||
@wxheader{dataobj.h}
|
||||
@ -392,8 +392,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
wxDataObject
|
||||
*/
|
||||
class wxURLDataObject
|
||||
{
|
||||
@ -416,6 +416,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataObject
|
||||
@wxheader{dataobj.h}
|
||||
@ -531,7 +532,7 @@ public:
|
||||
translation under Windows is not yet finished.
|
||||
|
||||
@b wxPython note: At this time this class is not directly usable from wxPython.
|
||||
Derive a class from wxPyDataObjectSimple
|
||||
Derive a class from wxPyDataObjectSimple()
|
||||
instead.
|
||||
|
||||
@b wxPerl note: This class is not currently usable from wxPerl; you may
|
||||
@ -540,8 +541,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref
|
||||
overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject, wxCustomDataObject, wxDropTarget, wxDropSource, wxTextDropTarget, wxFileDropTarget
|
||||
*/
|
||||
class wxDataObject
|
||||
@ -597,6 +597,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxTextDataObject
|
||||
@wxheader{dataobj.h}
|
||||
@ -624,8 +625,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
@see @ref overview_wxdndoverview "Clipboard and drag and drop overview",
|
||||
wxDataObject, wxDataObjectSimple, wxFileDataObject, wxBitmapDataObject
|
||||
*/
|
||||
class wxTextDataObject : public wxDataObjectSimple
|
||||
@ -664,6 +664,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileDataObject
|
||||
@wxheader{dataobj.h}
|
||||
@ -684,8 +685,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,
|
||||
@see wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject,
|
||||
wxDataObject
|
||||
*/
|
||||
class wxFileDataObject : public wxDataObjectSimple
|
||||
@ -702,7 +702,8 @@ public:
|
||||
virtual void AddFile(const wxString& file);
|
||||
|
||||
/**
|
||||
Returns the array of file names.
|
||||
Returns the array() of file names.
|
||||
*/
|
||||
const wxArrayString GetFilenames() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dataview.h
|
||||
// Purpose: documentation for wxDataViewIconText class
|
||||
// Purpose: interface of wxDataViewIconText
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -52,6 +52,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewEvent
|
||||
@wxheader{dataview.h}
|
||||
@ -127,6 +128,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewIconTextRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -152,6 +154,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewIndexListModel
|
||||
@wxheader{dataview.h}
|
||||
@ -197,7 +200,7 @@ public:
|
||||
/**
|
||||
Oberride this to indicate that the row has special font attributes.
|
||||
This only affects the
|
||||
wxDataViewTextRendererText renderer.
|
||||
wxDataViewTextRendererText() renderer.
|
||||
See also wxDataViewItemAttr.
|
||||
*/
|
||||
bool GetAttr(unsigned int row, unsigned int col,
|
||||
@ -272,6 +275,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewModel
|
||||
@wxheader{dataview.h}
|
||||
@ -396,7 +400,7 @@ public:
|
||||
/**
|
||||
Oberride this to indicate that the item has special font attributes.
|
||||
This only affects the
|
||||
wxDataViewTextRendererText renderer.
|
||||
wxDataViewTextRendererText() renderer.
|
||||
See also wxDataViewItemAttr.
|
||||
*/
|
||||
bool GetAttr(const wxDataViewItem& item, unsigned int col,
|
||||
@ -536,6 +540,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewCustomRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -656,6 +661,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewBitmapRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -676,17 +682,18 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewItemAttr
|
||||
@wxheader{dataview.h}
|
||||
|
||||
This class is used to indicate to a wxDataViewCtrl
|
||||
that a certain Item has extra font attributes
|
||||
that a certain Item() has extra font attributes
|
||||
for its renderer. For this, it is required to override
|
||||
wxDataViewModel::GetAttr.
|
||||
|
||||
Attributes are currently only supported by
|
||||
wxDataViewTextRendererText.
|
||||
wxDataViewTextRendererText().
|
||||
|
||||
@library{wxadv}
|
||||
@category{FIXME}
|
||||
@ -717,6 +724,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewItem
|
||||
@wxheader{dataview.h}
|
||||
@ -763,6 +771,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewCtrl
|
||||
@wxheader{dataview.h}
|
||||
@ -1111,6 +1120,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewModelNotifier
|
||||
@wxheader{dataview.h}
|
||||
@ -1198,6 +1208,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1315,6 +1326,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewTextRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1336,6 +1348,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewProgressRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1357,6 +1370,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewSpinRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1381,6 +1395,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewToggleRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1401,6 +1416,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewTreeCtrl
|
||||
@wxheader{dataview.h}
|
||||
@ -1591,6 +1607,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewTreeStore
|
||||
@wxheader{dataview.h}
|
||||
@ -1735,6 +1752,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewDateRenderer
|
||||
@wxheader{dataview.h}
|
||||
@ -1755,6 +1773,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewTextRendererAttr
|
||||
@wxheader{dataview.h}
|
||||
@ -1781,6 +1800,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataViewColumn
|
||||
@wxheader{dataview.h}
|
||||
@ -1906,3 +1926,4 @@ public:
|
||||
*/
|
||||
void SetTitle(const wxString& title);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: datectrl.h
|
||||
// Purpose: documentation for wxDatePickerCtrl class
|
||||
// Purpose: interface of wxDatePickerCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -52,8 +52,7 @@
|
||||
@category{miscpickers}
|
||||
@appearance{datepickerctrl.png}
|
||||
|
||||
@seealso
|
||||
wxCalendarCtrl, wxDateEvent
|
||||
@see wxCalendarCtrl, wxDateEvent
|
||||
*/
|
||||
class wxDatePickerCtrl : public wxControl
|
||||
{
|
||||
@ -154,3 +153,4 @@ public:
|
||||
*/
|
||||
void SetValue(const wxDateTime& dt);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dateevt.h
|
||||
// Purpose: documentation for wxDateEvent class
|
||||
// Purpose: interface of wxDateEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -31,3 +31,4 @@ public:
|
||||
*/
|
||||
void SetDate(const wxDateTime& date);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: datetime.h
|
||||
// Purpose: documentation for wxDateTime class
|
||||
// Purpose: interface of wxDateTime
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,8 +15,7 @@
|
||||
@library{wxbase}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan,
|
||||
@see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan,
|
||||
wxDateSpan, wxCalendarCtrl
|
||||
*/
|
||||
class wxDateTime
|
||||
@ -205,7 +204,7 @@ public:
|
||||
static int ConvertYearToBC(int year);
|
||||
|
||||
/**
|
||||
These functions carry out arithmetics on the wxDateTime
|
||||
These functions carry out arithmetics() on the wxDateTime
|
||||
objects. As explained in the overview, either wxTimeSpan or wxDateSpan may be
|
||||
added to wxDateTime, hence all functions are overloaded to accept both
|
||||
arguments.
|
||||
@ -361,7 +360,8 @@ public:
|
||||
/**
|
||||
Returns the object having the same date component as this one but time of
|
||||
00:00:00.
|
||||
This function is new since wxWidgets version 2.8.2
|
||||
|
||||
@wxsince{2.8.2}
|
||||
|
||||
@see ResetTime()
|
||||
*/
|
||||
@ -1153,6 +1153,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDateTimeWorkDays
|
||||
@wxheader{datetime.h}
|
||||
@ -1168,6 +1169,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDateSpan
|
||||
@wxheader{datetime.h}
|
||||
@ -1210,8 +1212,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdatetimeoverview "Date classes overview", wxDateTime
|
||||
@see @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime
|
||||
*/
|
||||
class wxDateSpan
|
||||
{
|
||||
@ -1399,6 +1400,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxTimeSpan
|
||||
@wxheader{datetime.h}
|
||||
@ -1408,8 +1410,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdatetimeoverview "Date classes overview", wxDateTime
|
||||
@see @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime
|
||||
*/
|
||||
class wxTimeSpan
|
||||
{
|
||||
@ -1728,6 +1729,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDateTimeHolidayAuthority
|
||||
@wxheader{datetime.h}
|
||||
@ -1741,3 +1743,4 @@ class wxDateTimeHolidayAuthority
|
||||
public:
|
||||
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: datstrm.h
|
||||
// Purpose: documentation for wxDataOutputStream class
|
||||
// Purpose: interface of wxDataOutputStream
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -121,6 +121,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDataInputStream
|
||||
@wxheader{datstrm.h}
|
||||
@ -254,3 +255,4 @@ public:
|
||||
*/
|
||||
wxString ReadString();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dc.h
|
||||
// Purpose: documentation for wxDC class
|
||||
// Purpose: interface of wxDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -30,8 +30,7 @@
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
Overview
|
||||
@see Overview()
|
||||
*/
|
||||
class wxDC : public wxObject
|
||||
{
|
||||
@ -468,7 +467,7 @@ public:
|
||||
/**
|
||||
Returns the depth (number of bits/pixel) of this DC.
|
||||
|
||||
@see wxDisplayDepth
|
||||
@see wxDisplayDepth()
|
||||
*/
|
||||
int GetDepth() const;
|
||||
|
||||
@ -975,6 +974,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDCClipper
|
||||
@wxheader{dc.h}
|
||||
@ -1002,8 +1002,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{gdi}
|
||||
|
||||
@seealso
|
||||
wxDC::SetClippingRegion
|
||||
@see wxDC::SetClippingRegion
|
||||
*/
|
||||
class wxDCClipper
|
||||
{
|
||||
@ -1020,3 +1019,4 @@ public:
|
||||
wxDCClipper(wxDC& dc, int x, int y, int w, int h);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcbuffer.h
|
||||
// Purpose: documentation for wxBufferedDC class
|
||||
// Purpose: interface of wxBufferedDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -38,8 +38,7 @@
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxMemoryDC, wxBufferedPaintDC, wxAutoBufferedPaintDC
|
||||
@see wxDC, wxMemoryDC, wxBufferedPaintDC, wxAutoBufferedPaintDC
|
||||
*/
|
||||
class wxBufferedDC : public wxMemoryDC
|
||||
{
|
||||
@ -99,6 +98,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxAutoBufferedPaintDC
|
||||
@wxheader{dcbuffer.h}
|
||||
@ -120,8 +120,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxBufferedPaintDC
|
||||
@see wxDC, wxBufferedPaintDC
|
||||
*/
|
||||
class wxAutoBufferedPaintDC : public wxBufferedPaintDC
|
||||
{
|
||||
@ -133,6 +132,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxBufferedPaintDC
|
||||
@wxheader{dcbuffer.h}
|
||||
@ -152,8 +152,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxBufferedDC, wxAutoBufferedPaintDC
|
||||
@see wxDC, wxBufferedDC, wxAutoBufferedPaintDC
|
||||
*/
|
||||
class wxBufferedPaintDC : public wxBufferedDC
|
||||
{
|
||||
@ -182,3 +181,4 @@ public:
|
||||
object, using a wxPaintDC.
|
||||
*/
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcclient.h
|
||||
// Purpose: documentation for wxPaintDC class
|
||||
// Purpose: interface of wxPaintDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC
|
||||
@see wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC
|
||||
*/
|
||||
class wxPaintDC : public wxWindowDC
|
||||
{
|
||||
@ -42,6 +41,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxClientDC
|
||||
@wxheader{dcclient.h}
|
||||
@ -59,8 +59,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC
|
||||
@see wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC
|
||||
*/
|
||||
class wxClientDC : public wxWindowDC
|
||||
{
|
||||
@ -72,6 +71,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxWindowDC
|
||||
@wxheader{dcclient.h}
|
||||
@ -92,8 +92,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxScreenDC
|
||||
@see wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxScreenDC
|
||||
*/
|
||||
class wxWindowDC : public wxDC
|
||||
{
|
||||
@ -103,3 +102,4 @@ public:
|
||||
*/
|
||||
wxWindowDC(wxWindow* window);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcmemory.h
|
||||
// Purpose: documentation for wxMemoryDC class
|
||||
// Purpose: interface of wxMemoryDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -19,8 +19,7 @@
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxBitmap, wxDC
|
||||
@see wxBitmap, wxDC
|
||||
*/
|
||||
class wxMemoryDC : public wxDC
|
||||
{
|
||||
@ -67,3 +66,4 @@ public:
|
||||
*/
|
||||
void SelectObjectAsSource(const wxBitmap& bitmap);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcmirror.h
|
||||
// Purpose: documentation for wxMirrorDC class
|
||||
// Purpose: interface of wxMirrorDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -32,3 +32,4 @@ public:
|
||||
*/
|
||||
wxMirrorDC(wxDC& dc, bool mirror);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcprint.h
|
||||
// Purpose: documentation for wxPrinterDC class
|
||||
// Purpose: interface of wxPrinterDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -18,8 +18,7 @@
|
||||
@library{wxcore}
|
||||
@category{printing}
|
||||
|
||||
@seealso
|
||||
@ref overview_printingoverview "Printing framework overview", wxDC
|
||||
@see @ref overview_printingoverview "Printing framework overview", wxDC
|
||||
*/
|
||||
class wxPrinterDC : public wxDC
|
||||
{
|
||||
@ -52,3 +51,4 @@ public:
|
||||
*/
|
||||
wxRect wxPrinterDC::GetPaperRect();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcps.h
|
||||
// Purpose: documentation for wxPostScriptDC class
|
||||
// Purpose: interface of wxPostScriptDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -52,6 +52,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcscreen.h
|
||||
// Purpose: documentation for wxScreenDC class
|
||||
// Purpose: interface of wxScreenDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -17,8 +17,7 @@
|
||||
@library{wxcore}
|
||||
@category{dc}
|
||||
|
||||
@seealso
|
||||
wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxWindowDC
|
||||
@see wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxWindowDC
|
||||
*/
|
||||
class wxScreenDC : public wxDC
|
||||
{
|
||||
@ -65,3 +64,4 @@ public:
|
||||
bool StartDrawingOnTop(wxRect* rect = NULL);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dcsvg.h
|
||||
// Purpose: documentation for wxSVGFileDC class
|
||||
// Purpose: interface of wxSVGFileDC
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -36,8 +36,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@b Members
|
||||
@see @b Members
|
||||
*/
|
||||
class wxSVGFileDC : public wxDC
|
||||
{
|
||||
@ -648,3 +647,4 @@ public:
|
||||
*/
|
||||
bool StartDoc(const wxString& message);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dde.h
|
||||
// Purpose: documentation for wxDDEConnection class
|
||||
// Purpose: interface of wxDDEConnection
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess
|
||||
@see wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess
|
||||
communications overview"
|
||||
*/
|
||||
class wxDDEConnection : public wxObject
|
||||
@ -197,6 +196,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDDEClient
|
||||
@wxheader{dde.h}
|
||||
@ -218,8 +218,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess
|
||||
@see wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess
|
||||
communications overview"
|
||||
*/
|
||||
class wxDDEClient : public wxObject
|
||||
@ -263,6 +262,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDDEServer
|
||||
@wxheader{dde.h}
|
||||
@ -277,8 +277,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview"
|
||||
@see wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview"
|
||||
*/
|
||||
class wxDDEServer
|
||||
{
|
||||
@ -310,6 +309,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -318,7 +318,7 @@ public:
|
||||
Called when wxWidgets exits, to clean up the DDE system. This no longer needs
|
||||
to be
|
||||
called by the application.
|
||||
See also wxDDEInitialize.
|
||||
See also wxDDEInitialize().
|
||||
*/
|
||||
void wxDDECleanUp();
|
||||
|
||||
@ -327,7 +327,7 @@ void wxDDECleanUp();
|
||||
This no longer needs to be called by the application: it will be called
|
||||
by wxWidgets if necessary.
|
||||
See also wxDDEServer, wxDDEClient, wxDDEConnection,
|
||||
wxDDECleanUp.
|
||||
wxDDECleanUp().
|
||||
*/
|
||||
void wxDDEInitialize();
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: debug.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
/**
|
||||
Will always generate an assert error if this code is reached (in debug mode).
|
||||
See also: wxFAIL_MSG
|
||||
See also: wxFAIL_MSG()
|
||||
*/
|
||||
wxFAIL();
|
||||
|
||||
@ -16,7 +16,7 @@ wxFAIL();
|
||||
/**
|
||||
This function is called whenever one of debugging macros fails (i.e. condition
|
||||
is @false in an assertion). It is only defined in the debug mode, in release
|
||||
builds the wxCHECK failures don't result in anything.
|
||||
builds the wxCHECK() failures don't result in anything.
|
||||
To override the default behaviour in the debug builds which is to show the user
|
||||
a dialog asking whether he wants to abort the program, continue or continue
|
||||
ignoring any subsequent assert failures, you may override
|
||||
@ -43,7 +43,7 @@ void wxTrap();
|
||||
it may be used in the "default:" branch of a switch statement if all possible
|
||||
cases are processed above.
|
||||
|
||||
@see wxFAIL
|
||||
@see wxFAIL()
|
||||
*/
|
||||
#define wxFAIL_MSG(msg) /* implementation is private */
|
||||
|
||||
@ -74,13 +74,13 @@ void wxTrap();
|
||||
Assert macro with message. An error message will be generated if the condition
|
||||
is @false.
|
||||
|
||||
@see wxASSERT, wxCOMPILE_TIME_ASSERT
|
||||
@see wxASSERT(), wxCOMPILE_TIME_ASSERT()
|
||||
*/
|
||||
#define wxASSERT_MSG(condition, msg) /* implementation is private */
|
||||
|
||||
/**
|
||||
This is the same as wxCHECK2, but
|
||||
wxFAIL_MSG with the specified @a msg is called
|
||||
This is the same as wxCHECK2(), but
|
||||
wxFAIL_MSG() with the specified @a msg is called
|
||||
instead of wxFAIL() if the @a condition is @false.
|
||||
*/
|
||||
#define wxCHECK2(condition, operation, msg) /* implementation is private */
|
||||
@ -91,7 +91,7 @@ void wxTrap();
|
||||
Please note that the condition in wxASSERT() should have no side effects
|
||||
because it will not be executed in release mode at all.
|
||||
|
||||
@see wxASSERT_MSG, wxCOMPILE_TIME_ASSERT
|
||||
@see wxASSERT_MSG(), wxCOMPILE_TIME_ASSERT()
|
||||
*/
|
||||
#define wxASSERT(condition) /* implementation is private */
|
||||
|
||||
@ -99,24 +99,24 @@ void wxTrap();
|
||||
Checks that the condition is @true, and returns if not (FAILs with given error
|
||||
message in debug mode). This check is done even in release mode.
|
||||
This macro should be used in void functions instead of
|
||||
wxCHECK_MSG.
|
||||
wxCHECK_MSG().
|
||||
*/
|
||||
#define wxCHECK_RET(condition, msg) /* implementation is private */
|
||||
|
||||
/**
|
||||
Checks that the condition is @true and wxFAIL and execute
|
||||
Checks that the condition is @true and wxFAIL() and execute
|
||||
@a operation if it is not. This is a generalisation of
|
||||
wxCHECK and may be used when something else than just
|
||||
wxCHECK() and may be used when something else than just
|
||||
returning from the function must be done when the @a condition is @false.
|
||||
This check is done even in release mode.
|
||||
*/
|
||||
#define wxCHECK2(condition, operation) /* implementation is private */
|
||||
|
||||
/**
|
||||
This macro is identical to wxCOMPILE_TIME_ASSERT2
|
||||
This macro is identical to wxCOMPILE_TIME_ASSERT2()
|
||||
except that it allows you to specify a unique @a name for the struct
|
||||
internally defined by this macro to avoid getting the compilation errors
|
||||
described above.
|
||||
described above().
|
||||
*/
|
||||
#define wxCOMPILE_TIME_ASSERT(condition, msg, name) /* implementation is private */
|
||||
|
||||
@ -125,7 +125,7 @@ void wxTrap();
|
||||
(FAILs in debug mode).
|
||||
This check is done even in release mode.
|
||||
This macro may be only used in non-void functions, see also
|
||||
wxCHECK_RET.
|
||||
wxCHECK_RET().
|
||||
*/
|
||||
#define wxCHECK_MSG(condition, retValue, msg) /* implementation is private */
|
||||
|
||||
@ -141,13 +141,13 @@ void wxTrap();
|
||||
unique by using the @c __LINE__ in it but it may still not work if you
|
||||
use it on the same line in two different source files. In this case you may
|
||||
either change the line in which either of them appears on or use the
|
||||
wxCOMPILE_TIME_ASSERT2 macro.
|
||||
wxCOMPILE_TIME_ASSERT2() macro.
|
||||
Also note that Microsoft Visual C++ has a bug which results in compiler errors
|
||||
if you use this macro with 'Program Database For Edit And Continue'
|
||||
(@c /ZI) option, so you shouldn't use it ('Program Database'
|
||||
(@c /Zi) is ok though) for the code making use of this macro.
|
||||
|
||||
@see wxASSERT_MSG, wxASSERT_MIN_BITSIZE
|
||||
@see wxASSERT_MSG(), wxASSERT_MIN_BITSIZE()
|
||||
*/
|
||||
#define wxCOMPILE_TIME_ASSERT(condition, msg) /* implementation is private */
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: debugrpt.h
|
||||
// Purpose: documentation for wxDebugReportPreview class
|
||||
// Purpose: interface of wxDebugReportPreview
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -47,6 +47,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDebugReportCompress
|
||||
@wxheader{debugrpt.h}
|
||||
@ -73,6 +74,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDebugReport
|
||||
@wxheader{debugrpt.h}
|
||||
@ -80,7 +82,7 @@ public:
|
||||
wxDebugReport is used to generate a debug report, containing information about
|
||||
the program current state. It is usually used from
|
||||
wxApp::OnFatalException as shown in the
|
||||
sample.
|
||||
sample().
|
||||
|
||||
A wxDebugReport object contains one or more files. A few of them can be created
|
||||
by the
|
||||
@ -259,6 +261,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDebugReportPreviewStd
|
||||
@wxheader{debugrpt.h}
|
||||
@ -287,6 +290,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDebugReportUpload
|
||||
@wxheader{debugrpt.h}
|
||||
@ -323,3 +327,4 @@ public:
|
||||
*/
|
||||
bool OnServerReply();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: defs.h
|
||||
// Purpose: documentation for global functions
|
||||
// Purpose: interface of global functions
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -35,7 +35,7 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value);
|
||||
//@}
|
||||
|
||||
/**
|
||||
This macro is similar to wxDEPRECATED but can be used
|
||||
This macro is similar to wxDEPRECATED() but can be used
|
||||
to not only declare the function @a func as deprecated but to also provide
|
||||
its (inline) implementation @e body.
|
||||
It can be used as following:
|
||||
@ -131,7 +131,7 @@ wxUint16 wxUINT16_SWAP_ON_BE(wxUint16 value);
|
||||
void wxVaCopy(va_list argptrDst, va_list argptrSrc);
|
||||
|
||||
/**
|
||||
This is a special version of wxDEPRECATED macro which
|
||||
This is a special version of wxDEPRECATED() macro which
|
||||
only does something when the deprecated function is used from the code outside
|
||||
wxWidgets itself but doesn't generate warnings when it is used from wxWidgets.
|
||||
It is used with the virtual functions which are called by the library itself --
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dialog.h
|
||||
// Purpose: documentation for wxDialog class
|
||||
// Purpose: interface of wxDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -60,8 +60,7 @@
|
||||
@library{wxcore}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview
|
||||
@see @ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview
|
||||
"Validator overview"
|
||||
*/
|
||||
class wxDialog : public wxTopLevelWindow
|
||||
@ -488,6 +487,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDialogLayoutAdapter
|
||||
@wxheader{dialog.h}
|
||||
@ -506,8 +506,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_autoscrollingdialogs "Automatic scrolling dialogs"
|
||||
@see @ref overview_autoscrollingdialogs "Automatic scrolling dialogs"
|
||||
*/
|
||||
class wxDialogLayoutAdapter
|
||||
{
|
||||
@ -529,3 +528,4 @@ public:
|
||||
*/
|
||||
bool DoLayoutAdaptation(wxDialog* dialog);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dialup.h
|
||||
// Purpose: documentation for wxDialUpManager class
|
||||
// Purpose: interface of wxDialUpManager
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@library{wxcore}
|
||||
@category{net}
|
||||
|
||||
@seealso
|
||||
@ref overview_sampledialup "dialup sample", wxDialUpEvent
|
||||
@see @ref overview_sampledialup "dialup sample", wxDialUpEvent
|
||||
*/
|
||||
class wxDialUpManager
|
||||
{
|
||||
@ -165,6 +164,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDialUpEvent
|
||||
@wxheader{dialup.h}
|
||||
@ -196,3 +196,4 @@ public:
|
||||
*/
|
||||
bool IsOwnEvent() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dir.h
|
||||
// Purpose: documentation for wxDirTraverser class
|
||||
// Purpose: interface of wxDirTraverser
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -78,6 +78,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDir
|
||||
@wxheader{dir.h}
|
||||
@ -203,7 +204,7 @@ public:
|
||||
big, it could be
|
||||
far from real size of the directory.
|
||||
See also: wxFileName::GetHumanReadableSize,
|
||||
wxGetDiskSpace
|
||||
wxGetDiskSpace()
|
||||
*/
|
||||
static wxULongLong GetTotalSize(const wxString& dir,
|
||||
wxArrayString* filesSkipped = NULL);
|
||||
@ -253,3 +254,4 @@ public:
|
||||
const wxString& filespec = wxEmptyString,
|
||||
int flags = wxDIR_DEFAULT);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dirctrl.h
|
||||
// Purpose: documentation for wxGenericDirCtrl class
|
||||
// Purpose: interface of wxGenericDirCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -172,3 +172,4 @@ public:
|
||||
*/
|
||||
void ShowHidden(bool show);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dirdlg.h
|
||||
// Purpose: documentation for wxDirDialog class
|
||||
// Purpose: interface of wxDirDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@library{wxcore}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog
|
||||
@see @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog
|
||||
*/
|
||||
class wxDirDialog : public wxDialog
|
||||
{
|
||||
@ -95,6 +94,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: display.h
|
||||
// Purpose: documentation for wxDisplay class
|
||||
// Purpose: interface of wxDisplay
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,8 +15,7 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxClientDisplayRect, wxDisplaySize, wxDisplaySizeMM
|
||||
@see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
|
||||
*/
|
||||
class wxDisplay
|
||||
{
|
||||
@ -120,3 +119,4 @@ public:
|
||||
*/
|
||||
bool IsPrimary();
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dnd.h
|
||||
// Purpose: documentation for wxTextDropTarget class
|
||||
// Purpose: interface of wxTextDropTarget
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,8 +15,7 @@
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxFileDropTarget
|
||||
@see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxFileDropTarget
|
||||
*/
|
||||
class wxTextDropTarget : public wxDropTarget
|
||||
{
|
||||
@ -47,6 +46,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDropTarget
|
||||
@wxheader{dnd.h}
|
||||
@ -73,8 +73,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat, wxDataObject
|
||||
@see wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat,
|
||||
wxDataObject
|
||||
*/
|
||||
class wxDropTarget
|
||||
{
|
||||
@ -168,6 +168,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDropSource
|
||||
@wxheader{dnd.h}
|
||||
@ -180,8 +181,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
wxDropTarget, wxTextDropTarget, wxFileDropTarget
|
||||
@see wxDropTarget, wxTextDropTarget, wxFileDropTarget
|
||||
*/
|
||||
class wxDropSource
|
||||
{
|
||||
@ -193,7 +193,7 @@ public:
|
||||
SetData() later.
|
||||
Note that the exact type of @a iconCopy and subsequent parameters differs
|
||||
between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
|
||||
You should use the macro wxDROP_ICON in portable
|
||||
You should use the macro wxDROP_ICON() in portable
|
||||
programs instead of directly using either of these types.
|
||||
|
||||
@param win
|
||||
@ -279,6 +279,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileDropTarget
|
||||
@wxheader{dnd.h}
|
||||
@ -289,8 +290,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxTextDropTarget
|
||||
@see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxTextDropTarget
|
||||
*/
|
||||
class wxFileDropTarget : public wxDropTarget
|
||||
{
|
||||
@ -321,6 +321,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: docmdi.h
|
||||
// Purpose: documentation for wxDocMDIParentFrame class
|
||||
// Purpose: interface of wxDocMDIParentFrame
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,15 +15,14 @@
|
||||
MDI parent frames.
|
||||
|
||||
It cooperates with the wxView, wxDocument,
|
||||
wxDocManager and wxDocTemplates classes.
|
||||
wxDocManager and wxDocTemplates() classes.
|
||||
|
||||
See the example application in @c samples/docview.
|
||||
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_docviewoverview, wxMDIParentFrame
|
||||
@see @ref overview_docviewoverview, wxMDIParentFrame
|
||||
*/
|
||||
class wxDocMDIParentFrame : public wxMDIParentFrame
|
||||
{
|
||||
@ -67,6 +66,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDocMDIChildFrame
|
||||
@wxheader{docmdi.h}
|
||||
@ -83,8 +83,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_docviewoverview, wxMDIChildFrame
|
||||
@see @ref overview_docviewoverview, wxMDIChildFrame
|
||||
*/
|
||||
class wxDocMDIChildFrame : public wxMDIChildFrame
|
||||
{
|
||||
@ -149,3 +148,4 @@ public:
|
||||
The view associated with the frame.
|
||||
*/
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: docview.h
|
||||
// Purpose: documentation for wxDocTemplate class
|
||||
// Purpose: interface of wxDocTemplate
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -16,8 +16,8 @@
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument, wxView
|
||||
@see @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument,
|
||||
wxView
|
||||
*/
|
||||
class wxDocTemplate : public wxObject
|
||||
{
|
||||
@ -258,6 +258,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDocManager
|
||||
@wxheader{docview.h}
|
||||
@ -270,9 +271,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument, wxView,
|
||||
wxDocTemplate, wxFileHistory
|
||||
@see @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument,
|
||||
wxView, wxDocTemplate, wxFileHistory
|
||||
*/
|
||||
class wxDocManager : public wxEvtHandler
|
||||
{
|
||||
@ -368,7 +368,7 @@ public:
|
||||
/**
|
||||
Loads the file history from a config object.
|
||||
|
||||
@see wxConfig
|
||||
@see wxConfig()
|
||||
*/
|
||||
void FileHistoryLoad(wxConfigBase& config);
|
||||
|
||||
@ -382,7 +382,7 @@ public:
|
||||
Saves the file history into a config object. This must be called
|
||||
explicitly by the application.
|
||||
|
||||
@see wxConfig
|
||||
@see wxConfig()
|
||||
*/
|
||||
void FileHistorySave(wxConfigBase& resourceFile);
|
||||
|
||||
@ -633,6 +633,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxView
|
||||
@wxheader{docview.h}
|
||||
@ -646,8 +647,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,
|
||||
@see @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,
|
||||
wxDocManager
|
||||
*/
|
||||
class wxView : public wxEvtHandler
|
||||
@ -817,6 +817,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDocChildFrame
|
||||
@wxheader{docview.h}
|
||||
@ -833,8 +834,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_docviewoverview, wxFrame
|
||||
@see @ref overview_docviewoverview, wxFrame
|
||||
*/
|
||||
class wxDocChildFrame : public wxFrame
|
||||
{
|
||||
@ -900,6 +900,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDocParentFrame
|
||||
@wxheader{docview.h}
|
||||
@ -909,15 +910,14 @@ public:
|
||||
SDI (not MDI) parent frames.
|
||||
|
||||
It cooperates with the wxView, wxDocument,
|
||||
wxDocManager and wxDocTemplates classes.
|
||||
wxDocManager and wxDocTemplates() classes.
|
||||
|
||||
See the example application in @c samples/docview.
|
||||
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_docviewoverview, wxFrame
|
||||
@see @ref overview_docviewoverview, wxFrame
|
||||
*/
|
||||
class wxDocParentFrame : public wxFrame
|
||||
{
|
||||
@ -966,6 +966,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDocument
|
||||
@wxheader{docview.h}
|
||||
@ -978,9 +979,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{dvf}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxdocumentoverview "wxDocument overview", wxView, wxDocTemplate,
|
||||
wxDocManager
|
||||
@see @ref overview_wxdocumentoverview "wxDocument overview", wxView,
|
||||
wxDocTemplate, wxDocManager
|
||||
*/
|
||||
class wxDocument : public wxEvtHandler
|
||||
{
|
||||
@ -1033,7 +1033,7 @@ public:
|
||||
|
||||
/**
|
||||
Gets the document type name for this document. See the comment for
|
||||
documentTypeName.
|
||||
documentTypeName().
|
||||
*/
|
||||
wxString GetDocumentName() const;
|
||||
|
||||
@ -1217,7 +1217,7 @@ public:
|
||||
|
||||
/**
|
||||
Sets the document type name for this document. See the comment for
|
||||
documentTypeName.
|
||||
documentTypeName().
|
||||
*/
|
||||
void SetDocumentName(const wxString& name);
|
||||
|
||||
@ -1298,6 +1298,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileHistory
|
||||
@wxheader{docview.h}
|
||||
@ -1314,8 +1315,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager
|
||||
@see @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager
|
||||
*/
|
||||
class wxFileHistory : public wxObject
|
||||
{
|
||||
@ -1381,7 +1381,7 @@ public:
|
||||
Loads the file history from the given config object. This function should be
|
||||
called explicitly by the application.
|
||||
|
||||
@see wxConfig
|
||||
@see wxConfig()
|
||||
*/
|
||||
void Load(wxConfigBase& config);
|
||||
|
||||
@ -1399,7 +1399,7 @@ public:
|
||||
Saves the file history into the given config object. This must be called
|
||||
explicitly by the application.
|
||||
|
||||
@see wxConfig
|
||||
@see wxConfig()
|
||||
*/
|
||||
void Save(wxConfigBase& config);
|
||||
|
||||
@ -1443,6 +1443,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dragimag.h
|
||||
// Purpose: documentation for wxDragImage class
|
||||
// Purpose: interface of wxDragImage
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -195,3 +195,4 @@ public:
|
||||
const wxRect& sourceRect,
|
||||
const wxRect& destRect) const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dynarray.h
|
||||
// Purpose: documentation for wxArray<T> class
|
||||
// Purpose: interface of wxArray<T>
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -149,8 +149,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxcontaineroverview, wxListT, wxVectorT
|
||||
@see @ref overview_wxcontaineroverview, wxListT(), wxVectorT()
|
||||
*/
|
||||
class wxArray<T>
|
||||
{
|
||||
@ -169,7 +168,7 @@ public:
|
||||
because the other array types never take ownership of their elements. Also note
|
||||
that you cannot append more than one pointer as reusing it would lead to
|
||||
deleting it twice (or more) and hence to a crash.
|
||||
You may also use WX_APPEND_ARRAY macro to append all
|
||||
You may also use WX_APPEND_ARRAY() macro to append all
|
||||
elements of one array to another one but it is more efficient to use
|
||||
@a copies parameter and modify the elements in place later if you plan to
|
||||
append a lot of items.
|
||||
@ -200,9 +199,9 @@ public:
|
||||
|
||||
wxArray::SetCount
|
||||
|
||||
WX_APPEND_ARRAY
|
||||
WX_APPEND_ARRAY()
|
||||
|
||||
WX_PREPEND_ARRAY
|
||||
WX_PREPEND_ARRAY()
|
||||
*/
|
||||
|
||||
|
||||
@ -349,27 +348,27 @@ public:
|
||||
least) forward declared for WX_DEFINE_ARRAY, WX_DEFINE_SORTED_ARRAY and
|
||||
WX_DECLARE_OBJARRAY macros and must be fully declared before you use
|
||||
WX_DEFINE_OBJARRAY macro.
|
||||
WX_DEFINE_ARRAY
|
||||
WX_DEFINE_ARRAY()
|
||||
|
||||
WX_DEFINE_EXPORTED_ARRAY
|
||||
WX_DEFINE_EXPORTED_ARRAY()
|
||||
|
||||
WX_DEFINE_USER_EXPORTED_ARRAY
|
||||
WX_DEFINE_USER_EXPORTED_ARRAY()
|
||||
|
||||
WX_DEFINE_SORTED_ARRAY
|
||||
WX_DEFINE_SORTED_ARRAY()
|
||||
|
||||
WX_DEFINE_SORTED_EXPORTED_ARRAY
|
||||
WX_DEFINE_SORTED_EXPORTED_ARRAY()
|
||||
|
||||
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY
|
||||
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY()
|
||||
|
||||
WX_DECLARE_EXPORTED_OBJARRAY
|
||||
WX_DECLARE_EXPORTED_OBJARRAY()
|
||||
|
||||
WX_DECLARE_USER_EXPORTED_OBJARRAY
|
||||
WX_DECLARE_USER_EXPORTED_OBJARRAY()
|
||||
|
||||
WX_DEFINE_OBJARRAY
|
||||
WX_DEFINE_OBJARRAY()
|
||||
|
||||
WX_DEFINE_EXPORTED_OBJARRAY
|
||||
WX_DEFINE_EXPORTED_OBJARRAY()
|
||||
|
||||
WX_DEFINE_USER_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
|
||||
element type is not a pointer itself and, although it still works, this
|
||||
@ -393,17 +392,17 @@ public:
|
||||
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_ARRAY_INT()
|
||||
|
||||
WX_DEFINE_EXPORTED_ARRAY_INT
|
||||
WX_DEFINE_EXPORTED_ARRAY_INT()
|
||||
|
||||
WX_DEFINE_USER_EXPORTED_ARRAY_INT
|
||||
WX_DEFINE_USER_EXPORTED_ARRAY_INT()
|
||||
|
||||
WX_DEFINE_SORTED_ARRAY_INT
|
||||
WX_DEFINE_SORTED_ARRAY_INT()
|
||||
|
||||
WX_DEFINE_SORTED_EXPORTED_ARRAY_INT
|
||||
WX_DEFINE_SORTED_EXPORTED_ARRAY_INT()
|
||||
|
||||
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT
|
||||
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
|
||||
*/
|
||||
|
||||
|
||||
@ -445,11 +444,11 @@ public:
|
||||
array equal to @a item is removed, an assert failure will result from an
|
||||
attempt to remove an item which doesn't exist in the array.
|
||||
When an element is removed from wxObjArray it is deleted by the array - use
|
||||
Detach if you don't want this to happen. On the
|
||||
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
|
||||
See also WX_CLEAR_ARRAY() macro which deletes all
|
||||
elements of a wxArray (supposed to contain pointers).
|
||||
*/
|
||||
Remove(T item);
|
||||
@ -457,17 +456,17 @@ public:
|
||||
/**
|
||||
Removes @a count elements starting at @a index from the array. When an
|
||||
element is removed from wxObjArray it is deleted by the array - use
|
||||
Detach if you don't want this to happen. On
|
||||
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
|
||||
See also WX_CLEAR_ARRAY() macro which deletes all
|
||||
elements of a wxArray (supposed to contain pointers).
|
||||
*/
|
||||
RemoveAt(size_t index, size_t count = 1);
|
||||
|
||||
/**
|
||||
WX_CLEAR_ARRAY
|
||||
WX_CLEAR_ARRAY()
|
||||
|
||||
wxArray::Empty
|
||||
|
||||
@ -540,7 +539,7 @@ public:
|
||||
needed for exporting an array from a user DLL.
|
||||
Example:
|
||||
|
||||
You must use WX_DEFINE_OBJARRAY macro to define
|
||||
You must use WX_DEFINE_OBJARRAY() macro to define
|
||||
the array class - otherwise you would get link errors.
|
||||
*/
|
||||
WX_DECLARE_OBJARRAY(T, name);
|
||||
@ -568,7 +567,7 @@ public:
|
||||
//@{
|
||||
/**
|
||||
This macro defines the methods of the array class @a name not defined by the
|
||||
WX_DECLARE_OBJARRAY macro. You must include the
|
||||
WX_DECLARE_OBJARRAY() macro. You must include the
|
||||
file wx/arrimpl.cpp before using this macro and you must have the full
|
||||
declaration of the class of array elements in scope! If you forget to do the
|
||||
first, the error will be caught by the compiler, but, unfortunately, many
|
||||
@ -624,10 +623,11 @@ public:
|
||||
/**
|
||||
The wxObjArray destructor deletes all the items owned by the array. This is not
|
||||
done by wxArray and wxSortedArray versions - you may use
|
||||
WX_CLEAR_ARRAY macro for this.
|
||||
WX_CLEAR_ARRAY() macro for this.
|
||||
*/
|
||||
~wxArray();
|
||||
~wxSortedArray();
|
||||
~wxObjArray();
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: dynlib.h
|
||||
// Purpose: documentation for wxDynamicLibraryDetails class
|
||||
// Purpose: interface of wxDynamicLibraryDetails
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -59,6 +59,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDllLoader
|
||||
@wxheader{dynlib.h}
|
||||
@ -185,6 +186,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDynamicLibrary
|
||||
@wxheader{dynlib.h}
|
||||
@ -197,8 +199,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxDynamicLibrary::CanonicalizePluginName
|
||||
@see wxDynamicLibrary::CanonicalizePluginName
|
||||
*/
|
||||
class wxDynamicLibrary
|
||||
{
|
||||
@ -269,7 +270,7 @@ public:
|
||||
Returns pointer to symbol @a name in the library or @NULL if the library
|
||||
contains no such symbol.
|
||||
|
||||
@see wxDYNLIB_FUNCTION
|
||||
@see wxDYNLIB_FUNCTION()
|
||||
*/
|
||||
void* GetSymbol(const wxString& name) const;
|
||||
|
||||
@ -288,7 +289,8 @@ 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.
|
||||
This function is new since wxWidgets version 2.5.4
|
||||
|
||||
@wxsince{2.5.4}
|
||||
*/
|
||||
bool HasSymbol(const wxString& name) const;
|
||||
|
||||
@ -298,7 +300,7 @@ public:
|
||||
bool IsLoaded() const;
|
||||
|
||||
/**
|
||||
This static method returns an array containing the details
|
||||
This static method returns an array() containing the details
|
||||
of all modules loaded into the address space of the current project, the array
|
||||
elements are object of @c wxDynamicLibraryDetails class. The array will
|
||||
be empty if an error occurred.
|
||||
@ -356,6 +358,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: editlbox.h
|
||||
// Purpose: documentation for wxEditableListBox class
|
||||
// Purpose: interface of wxEditableListBox
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,8 +29,7 @@
|
||||
@library{wxadv}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxListBox
|
||||
@see wxListBox
|
||||
*/
|
||||
class wxEditableListBox : public wxPanel
|
||||
{
|
||||
@ -88,3 +87,4 @@ public:
|
||||
*/
|
||||
void SetStrings(const wxArrayString& strings);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: encconv.h
|
||||
// Purpose: documentation for wxEncodingConverter class
|
||||
// Purpose: interface of wxEncodingConverter
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -20,9 +20,8 @@
|
||||
@library{wxbase}
|
||||
@category{misc}
|
||||
|
||||
@seealso
|
||||
wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing non-English
|
||||
applications"
|
||||
@see wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing
|
||||
non-English applications"
|
||||
*/
|
||||
class wxEncodingConverter : public wxObject
|
||||
{
|
||||
@ -120,3 +119,4 @@ public:
|
||||
bool Init(wxFontEncoding input_enc, wxFontEncoding output_enc,
|
||||
int method = wxCONVERT_STRICT);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: event.h
|
||||
// Purpose: documentation for wxKeyEvent class
|
||||
// Purpose: interface of wxKeyEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -47,7 +47,7 @@
|
||||
1, the ASCII value of this key combination.
|
||||
|
||||
You may discover how the other keys on your system behave interactively by
|
||||
running the text wxWidgets sample and pressing some keys
|
||||
running the text() wxWidgets sample and pressing some keys
|
||||
in any of the text controls shown in it.
|
||||
|
||||
@b Note: If a key down (@c EVT_KEY_DOWN) event is caught and
|
||||
@ -104,7 +104,7 @@ public:
|
||||
/**
|
||||
Returns the virtual key code. ASCII events return normal ASCII values,
|
||||
while non-ASCII events return values such as @b WXK_LEFT for the
|
||||
left cursor key. See Keycodes for a full list of
|
||||
left cursor key. See Keycodes() for a full list of
|
||||
the virtual key codes.
|
||||
Note that in Unicode build, the returned value is meaningful only if the
|
||||
user entered a character that can be represented in current locale's default
|
||||
@ -216,7 +216,7 @@ public:
|
||||
long m_keyCode
|
||||
@b Deprecated: Please use GetKeyCode()
|
||||
instead!
|
||||
Virtual keycode. See Keycodes for a list of identifiers.
|
||||
Virtual keycode. See Keycodes() for a list of identifiers.
|
||||
*/
|
||||
|
||||
|
||||
@ -251,6 +251,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxJoystickEvent
|
||||
@wxheader{event.h}
|
||||
@ -261,8 +262,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxJoystick
|
||||
@see wxJoystick
|
||||
*/
|
||||
class wxJoystickEvent : public wxEvent
|
||||
{
|
||||
@ -351,6 +351,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxScrollWinEvent
|
||||
@wxheader{event.h}
|
||||
@ -360,8 +361,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxScrollEvent, @ref overview_eventhandlingoverview
|
||||
@see wxScrollEvent, @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxScrollWinEvent : public wxEvent
|
||||
{
|
||||
@ -387,6 +387,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSysColourChangedEvent
|
||||
@wxheader{event.h}
|
||||
@ -398,8 +399,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxSysColourChangedEvent : public wxEvent
|
||||
{
|
||||
@ -411,6 +411,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxWindowCreateEvent
|
||||
@wxheader{event.h}
|
||||
@ -424,8 +425,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxWindowDestroyEvent
|
||||
@see @ref overview_eventhandlingoverview, wxWindowDestroyEvent
|
||||
*/
|
||||
class wxWindowCreateEvent : public wxCommandEvent
|
||||
{
|
||||
@ -437,6 +437,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPaintEvent
|
||||
@wxheader{event.h}
|
||||
@ -451,8 +452,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxPaintEvent : public wxEvent
|
||||
{
|
||||
@ -464,6 +464,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMaximizeEvent
|
||||
@wxheader{event.h}
|
||||
@ -476,8 +477,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxTopLevelWindow::Maximize,
|
||||
@see @ref overview_eventhandlingoverview, wxTopLevelWindow::Maximize,
|
||||
wxTopLevelWindow::IsMaximized
|
||||
*/
|
||||
class wxMaximizeEvent : public wxEvent
|
||||
@ -490,6 +490,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxUpdateUIEvent
|
||||
@wxheader{event.h}
|
||||
@ -500,8 +501,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxUpdateUIEvent : public wxCommandEvent
|
||||
{
|
||||
@ -643,6 +643,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxClipboardTextEvent
|
||||
@wxheader{event.h}
|
||||
@ -667,8 +668,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxClipboard
|
||||
@see wxClipboard
|
||||
*/
|
||||
class wxClipboardTextEvent : public wxCommandEvent
|
||||
{
|
||||
@ -681,6 +681,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMouseEvent
|
||||
@wxheader{event.h}
|
||||
@ -727,8 +728,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxKeyEvent::CmdDown
|
||||
@see wxKeyEvent::CmdDown
|
||||
*/
|
||||
class wxMouseEvent : public wxEvent
|
||||
{
|
||||
@ -902,7 +902,8 @@ 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).
|
||||
This function is new since wxWidgets version 2.9.0
|
||||
|
||||
@wxsince{2.9.0}
|
||||
*/
|
||||
int GetClickCount() const;
|
||||
|
||||
@ -1140,6 +1141,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDropFilesEvent
|
||||
@wxheader{event.h}
|
||||
@ -1150,14 +1152,13 @@ public:
|
||||
wxWindow::DragAcceptFiles.
|
||||
|
||||
Important note: this is a separate implementation to the more general
|
||||
drag and drop implementation documented here. It uses the
|
||||
drag and drop implementation documented here(). It uses the
|
||||
older, Windows message-based approach of dropping files.
|
||||
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxDropFilesEvent : public wxEvent
|
||||
{
|
||||
@ -1203,6 +1204,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCommandEvent
|
||||
@wxheader{event.h}
|
||||
@ -1317,6 +1319,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxActivateEvent
|
||||
@wxheader{event.h}
|
||||
@ -1327,8 +1330,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxApp::IsActive
|
||||
@see @ref overview_eventhandlingoverview, wxApp::IsActive
|
||||
*/
|
||||
class wxActivateEvent : public wxEvent
|
||||
{
|
||||
@ -1346,6 +1348,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxContextMenuEvent
|
||||
@wxheader{event.h}
|
||||
@ -1357,7 +1360,7 @@ public:
|
||||
means that the event originated
|
||||
from a keyboard context button event, and you should compute a suitable
|
||||
position yourself,
|
||||
for example by calling wxGetMousePosition.
|
||||
for example by calling wxGetMousePosition().
|
||||
|
||||
When a keyboard context menu button is pressed on Windows, a right-click event
|
||||
with default position is sent first,
|
||||
@ -1368,8 +1371,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxcommandevent "Command events", @ref
|
||||
@see @ref overview_wxcommandevent "Command events", @ref
|
||||
overview_eventhandlingoverview
|
||||
*/
|
||||
class wxContextMenuEvent : public wxCommandEvent
|
||||
@ -1399,6 +1401,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxEraseEvent
|
||||
@wxheader{event.h}
|
||||
@ -1421,8 +1424,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxEraseEvent : public wxEvent
|
||||
{
|
||||
@ -1439,6 +1441,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFocusEvent
|
||||
@wxheader{event.h}
|
||||
@ -1454,8 +1457,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxFocusEvent : public wxEvent
|
||||
{
|
||||
@ -1474,6 +1476,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxChildFocusEvent
|
||||
@wxheader{event.h}
|
||||
@ -1489,8 +1492,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxChildFocusEvent : public wxCommandEvent
|
||||
{
|
||||
@ -1512,6 +1514,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMouseCaptureLostEvent
|
||||
@wxheader{event.h}
|
||||
@ -1530,8 +1533,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview,
|
||||
@see wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview,
|
||||
wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
|
||||
*/
|
||||
class wxMouseCaptureLostEvent : public wxEvent
|
||||
@ -1544,6 +1546,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxNotifyEvent
|
||||
@wxheader{event.h}
|
||||
@ -1558,8 +1561,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxNotebookEvent
|
||||
@see wxNotebookEvent
|
||||
*/
|
||||
class wxNotifyEvent : public wxCommandEvent
|
||||
{
|
||||
@ -1593,6 +1595,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxHelpEvent
|
||||
@wxheader{event.h}
|
||||
@ -1621,8 +1624,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxContextHelp, wxDialog, @ref overview_eventhandlingoverview
|
||||
@see wxContextHelp, wxDialog, @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxHelpEvent : public wxCommandEvent
|
||||
{
|
||||
@ -1651,7 +1653,7 @@ public:
|
||||
MS Windows.
|
||||
|
||||
The application may handle events generated using the keyboard or mouse
|
||||
differently, e.g. by using wxGetMousePosition
|
||||
differently, e.g. by using wxGetMousePosition()
|
||||
for the mouse events.
|
||||
|
||||
@see SetOrigin()
|
||||
@ -1678,12 +1680,13 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxScrollEvent
|
||||
@wxheader{event.h}
|
||||
|
||||
A scroll event holds information about events sent from stand-alone
|
||||
scrollbars and sliders. Note that
|
||||
scrollbars() and sliders(). Note that
|
||||
starting from wxWidgets 2.1, scrolled windows send the
|
||||
wxScrollWinEvent which does not derive from
|
||||
wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
|
||||
@ -1693,8 +1696,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref
|
||||
@see wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref
|
||||
overview_eventhandlingoverview
|
||||
*/
|
||||
class wxScrollEvent : public wxCommandEvent
|
||||
@ -1719,6 +1721,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxIdleEvent
|
||||
@wxheader{event.h}
|
||||
@ -1730,7 +1733,7 @@ public:
|
||||
happens and only then is the next idle event sent again. If you need to ensure
|
||||
a continuous stream of idle events, you can either use
|
||||
wxIdleEvent::RequestMore method in your handler or call
|
||||
wxWakeUpIdle periodically (for example from timer
|
||||
wxWakeUpIdle() periodically (for example from timer
|
||||
event), but note that both of these approaches (and especially the first one)
|
||||
increase the system load and so should be avoided if possible.
|
||||
|
||||
@ -1743,8 +1746,8 @@ public:
|
||||
@library{wxbase}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxUpdateUIEvent, wxWindow::OnInternalIdle
|
||||
@see @ref overview_eventhandlingoverview, wxUpdateUIEvent,
|
||||
wxWindow::OnInternalIdle
|
||||
*/
|
||||
class wxIdleEvent : public wxEvent
|
||||
{
|
||||
@ -1811,6 +1814,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxInitDialogEvent
|
||||
@wxheader{event.h}
|
||||
@ -1822,8 +1826,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxInitDialogEvent : public wxEvent
|
||||
{
|
||||
@ -1835,6 +1838,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxWindowDestroyEvent
|
||||
@wxheader{event.h}
|
||||
@ -1855,8 +1859,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxWindowCreateEvent
|
||||
@see @ref overview_eventhandlingoverview, wxWindowCreateEvent
|
||||
*/
|
||||
class wxWindowDestroyEvent : public wxCommandEvent
|
||||
{
|
||||
@ -1868,6 +1871,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxNavigationKeyEvent
|
||||
@wxheader{event.h}
|
||||
@ -1883,8 +1887,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxWindow::Navigate, wxWindow::NavigateIn
|
||||
@see wxWindow::Navigate, wxWindow::NavigateIn
|
||||
*/
|
||||
class wxNavigationKeyEvent
|
||||
{
|
||||
@ -1948,6 +1951,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMouseCaptureChangedEvent
|
||||
@wxheader{event.h}
|
||||
@ -1963,8 +1967,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview,
|
||||
@see wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview,
|
||||
wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
|
||||
*/
|
||||
class wxMouseCaptureChangedEvent : public wxEvent
|
||||
@ -1984,6 +1987,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxCloseEvent
|
||||
@wxheader{event.h}
|
||||
@ -2011,8 +2015,8 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxWindow::Close, @ref overview_windowdeletionoverview "Window deletion overview"
|
||||
@see wxWindow::Close, @ref overview_windowdeletionoverview "Window deletion
|
||||
overview"
|
||||
*/
|
||||
class wxCloseEvent : public wxEvent
|
||||
{
|
||||
@ -2062,6 +2066,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMenuEvent
|
||||
@wxheader{event.h}
|
||||
@ -2076,8 +2081,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxcommandevent "Command events", @ref
|
||||
@see @ref overview_wxcommandevent "Command events", @ref
|
||||
overview_eventhandlingoverview
|
||||
*/
|
||||
class wxMenuEvent : public wxEvent
|
||||
@ -2110,6 +2114,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxEventBlocker
|
||||
@wxheader{event.h}
|
||||
@ -2137,8 +2142,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxEvtHandler
|
||||
@see @ref overview_eventhandlingoverview, wxEvtHandler
|
||||
*/
|
||||
class wxEventBlocker : public wxEvtHandler
|
||||
{
|
||||
@ -2167,6 +2171,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxEvtHandler
|
||||
@wxheader{event.h}
|
||||
@ -2184,8 +2189,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview
|
||||
@see @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxEvtHandler : public wxObject
|
||||
{
|
||||
@ -2456,6 +2460,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxIconizeEvent
|
||||
@wxheader{event.h}
|
||||
@ -2467,8 +2472,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
@ref overview_eventhandlingoverview, wxTopLevelWindow::Iconize,
|
||||
@see @ref overview_eventhandlingoverview, wxTopLevelWindow::Iconize,
|
||||
wxTopLevelWindow::IsIconized
|
||||
*/
|
||||
class wxIconizeEvent : public wxEvent
|
||||
@ -2487,6 +2491,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxMoveEvent
|
||||
@wxheader{event.h}
|
||||
@ -2496,8 +2501,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxPoint, @ref overview_eventhandlingoverview
|
||||
@see wxPoint, @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxMoveEvent : public wxEvent
|
||||
{
|
||||
@ -2514,6 +2518,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxEvent
|
||||
@wxheader{event.h}
|
||||
@ -2530,8 +2535,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxCommandEvent, wxMouseEvent
|
||||
@see wxCommandEvent, wxMouseEvent
|
||||
*/
|
||||
class wxEvent : public wxObject
|
||||
{
|
||||
@ -2545,7 +2549,7 @@ public:
|
||||
Returns a copy of the event.
|
||||
Any event that is posted to the wxWidgets event system for later action (via
|
||||
wxEvtHandler::AddPendingEvent or
|
||||
wxPostEvent) must implement this method. All wxWidgets
|
||||
wxPostEvent()) must implement this method. All wxWidgets
|
||||
events fully implement this method, but any derived events implemented by the
|
||||
user should also implement this method just in case they (or some event
|
||||
derived from them) are ever posted.
|
||||
@ -2664,6 +2668,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSizeEvent
|
||||
@wxheader{event.h}
|
||||
@ -2690,8 +2695,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
@seealso
|
||||
wxSize, @ref overview_eventhandlingoverview
|
||||
@see wxSize, @ref overview_eventhandlingoverview
|
||||
*/
|
||||
class wxSizeEvent : public wxEvent
|
||||
{
|
||||
@ -2708,6 +2712,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSetCursorEvent
|
||||
@wxheader{event.h}
|
||||
@ -2721,8 +2726,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
::wxSetCursor, wxWindow::wxSetCursor
|
||||
@see ::wxSetCursor, wxWindow::wxSetCursor
|
||||
*/
|
||||
class wxSetCursorEvent : public wxEvent
|
||||
{
|
||||
@ -2761,3 +2765,4 @@ public:
|
||||
*/
|
||||
void SetCursor(const wxCursor& cursor);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fdrepdlg.h
|
||||
// Purpose: documentation for wxFindDialogEvent class
|
||||
// Purpose: interface of wxFindDialogEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -48,6 +48,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFindReplaceData
|
||||
@wxheader{fdrepdlg.h}
|
||||
@ -105,6 +106,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFindReplaceDialog
|
||||
@wxheader{fdrepdlg.h}
|
||||
@ -156,3 +158,4 @@ public:
|
||||
*/
|
||||
const wxFindReplaceData* GetData() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: ffile.h
|
||||
// Purpose: documentation for wxFFile class
|
||||
// Purpose: interface of wxFFile
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -19,8 +19,7 @@
|
||||
@library{wxbase}
|
||||
@category{file}
|
||||
|
||||
@seealso
|
||||
wxFFile::IsOpened
|
||||
@see wxFFile::IsOpened
|
||||
*/
|
||||
class wxFFile
|
||||
{
|
||||
@ -190,3 +189,4 @@ public:
|
||||
*/
|
||||
FILE* fp() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: file.h
|
||||
// Purpose: documentation for wxTempFile class
|
||||
// Purpose: interface of wxTempFile
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -119,6 +119,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFile
|
||||
@wxheader{file.h}
|
||||
@ -321,3 +322,4 @@ public:
|
||||
*/
|
||||
int fd() const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fileconf.h
|
||||
// Purpose: documentation for wxFileConfig class
|
||||
// Purpose: interface of wxFileConfig
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -23,8 +23,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxFileConfig::Save
|
||||
@see wxFileConfig::Save
|
||||
*/
|
||||
class wxFileConfig : public wxConfigBase
|
||||
{
|
||||
@ -80,7 +79,8 @@ public:
|
||||
@c SetUmask(0077).
|
||||
This function doesn't do anything on non-Unix platforms.
|
||||
|
||||
@see wxCHANGE_UMASK
|
||||
@see wxCHANGE_UMASK()
|
||||
*/
|
||||
void SetUmask(int mode);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filectrl.h
|
||||
// Purpose: documentation for wxFileCtrl class
|
||||
// Purpose: interface of wxFileCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -33,8 +33,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxGenericDirCtrl
|
||||
@see wxGenericDirCtrl
|
||||
*/
|
||||
class wxFileCtrl : public wxWindow
|
||||
{
|
||||
@ -170,6 +169,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileCtrlEvent
|
||||
@wxheader{filectrl.h}
|
||||
@ -212,3 +212,4 @@ public:
|
||||
*/
|
||||
wxFileCtrlEvent::SetFiles(const wxArrayString files);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filedlg.h
|
||||
// Purpose: documentation for wxFileDialog class
|
||||
// Purpose: interface of wxFileDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -41,8 +41,8 @@
|
||||
@library{wxcore}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxfiledialogoverview "wxFileDialog overview", wxFileSelector
|
||||
@see @ref overview_wxfiledialogoverview "wxFileDialog overview",
|
||||
wxFileSelector()
|
||||
*/
|
||||
class wxFileDialog : public wxDialog
|
||||
{
|
||||
@ -200,6 +200,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filefn.h
|
||||
// Purpose: documentation for wxPathList class
|
||||
// Purpose: interface of wxPathList
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -21,8 +21,7 @@
|
||||
@library{wxbase}
|
||||
@category{file}
|
||||
|
||||
@seealso
|
||||
wxArrayString, wxStandardPaths, wxFileName
|
||||
@see wxArrayString, wxStandardPaths, wxFileName
|
||||
*/
|
||||
class wxPathList : public wxArrayString
|
||||
{
|
||||
@ -89,13 +88,14 @@ public:
|
||||
Note in fact that wxPathList can be used to store both relative and absolute
|
||||
paths so that
|
||||
if you Added() relative paths, then the current working directory
|
||||
(see wxGetCwd and wxSetWorkingDirectory)
|
||||
(see wxGetCwd() and wxSetWorkingDirectory())
|
||||
may affect the value returned by this function!
|
||||
*/
|
||||
wxString FindValidPath(const wxString& file) const;
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -228,13 +228,13 @@ bool wxFileExists(const wxString& filename);
|
||||
/**
|
||||
Returns @true if the @a pattern matches the @e text; if @a dot_special is @true,
|
||||
filenames beginning with a dot are not matched
|
||||
with wildcard characters. See wxIsWild.
|
||||
with wildcard characters. See wxIsWild().
|
||||
*/
|
||||
bool wxMatchWild(const wxString& pattern, const wxString& text,
|
||||
bool dot_special);
|
||||
|
||||
/**
|
||||
@b NB: This function is deprecated: use wxGetCwd instead.
|
||||
@b NB: This function is deprecated: use wxGetCwd() instead.
|
||||
Copies the current working directory into the buffer if supplied, or
|
||||
copies the working directory into new storage (which you must delete
|
||||
yourself) if the buffer is @NULL.
|
||||
@ -248,7 +248,7 @@ wxString wxGetWorkingDirectory(char* buf = NULL, int sz = 1000);
|
||||
wxString wxPathOnly(const wxString& path);
|
||||
|
||||
/**
|
||||
Returns @true if the pattern contains wildcards. See wxMatchWild.
|
||||
Returns @true if the pattern contains wildcards. See wxMatchWild().
|
||||
*/
|
||||
bool wxIsWild(const wxString& pattern);
|
||||
|
||||
@ -296,14 +296,14 @@ bool wxMkdir(const wxString& dir, int perm = 0777);
|
||||
bool wxIsAbsolutePath(const wxString& filename);
|
||||
|
||||
/**
|
||||
Returns the next file that matches the path passed to wxFindFirstFile.
|
||||
See wxFindFirstFile for an example.
|
||||
Returns the next file that matches the path passed to wxFindFirstFile().
|
||||
See wxFindFirstFile() for an example.
|
||||
*/
|
||||
wxString wxFindNextFile();
|
||||
|
||||
/**
|
||||
This function does directory searching; returns the first file
|
||||
that matches the path @e spec, or the empty string. Use wxFindNextFile to
|
||||
that matches the path @e spec, or the empty string. Use wxFindNextFile() to
|
||||
get the next matching file. Neither will report the current directory "." or the
|
||||
parent directory "..".
|
||||
*/
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filename.h
|
||||
// Purpose: documentation for wxFileName class
|
||||
// Purpose: interface of wxFileName
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -44,7 +44,7 @@
|
||||
a complete file name (such as when interpreting user input) you need to use
|
||||
the static function wxFileName::DirExists
|
||||
(or its identical variants wxDir::Exists and
|
||||
wxDirExists) and construct the wxFileName
|
||||
wxDirExists()) and construct the wxFileName
|
||||
instance accordingly. This will only work if the directory actually exists,
|
||||
of course:
|
||||
|
||||
@ -62,8 +62,7 @@
|
||||
@library{wxbase}
|
||||
@category{file}
|
||||
|
||||
@seealso
|
||||
wxFileName::GetCwd
|
||||
@see wxFileName::GetCwd
|
||||
*/
|
||||
class wxFileName
|
||||
{
|
||||
@ -1002,3 +1001,4 @@ public:
|
||||
const bool operator operator==(const wxString& filename) const;
|
||||
//@}
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filepicker.h
|
||||
// Purpose: documentation for wxFilePickerCtrl class
|
||||
// Purpose: interface of wxFilePickerCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -45,8 +45,7 @@
|
||||
@category{miscpickers}
|
||||
@appearance{filepickerctrl.png}
|
||||
|
||||
@seealso
|
||||
wxFileDialog, wxFileDirPickerEvent
|
||||
@see wxFileDialog, wxFileDirPickerEvent
|
||||
*/
|
||||
class wxFilePickerCtrl : public wxPickerBase
|
||||
{
|
||||
@ -128,6 +127,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxDirPickerCtrl
|
||||
@wxheader{filepicker.h}
|
||||
@ -163,8 +163,7 @@ public:
|
||||
@category{miscpickers}
|
||||
@appearance{dirpickerctrl.png}
|
||||
|
||||
@seealso
|
||||
wxDirDialog, wxFileDirPickerEvent
|
||||
@see wxDirDialog, wxFileDirPickerEvent
|
||||
*/
|
||||
class wxDirPickerCtrl : public wxPickerBase
|
||||
{
|
||||
@ -242,6 +241,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileDirPickerEvent
|
||||
@wxheader{filepicker.h}
|
||||
@ -252,8 +252,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxfilepickerctrl
|
||||
@see wxfilepickerctrl()
|
||||
*/
|
||||
class wxFileDirPickerEvent : public wxCommandEvent
|
||||
{
|
||||
@ -275,3 +274,4 @@ public:
|
||||
*/
|
||||
void SetPath(const wxString& path);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: filesys.h
|
||||
// Purpose: documentation for wxFileSystem class
|
||||
// Purpose: interface of wxFileSystem
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -12,14 +12,13 @@
|
||||
|
||||
This class provides an interface for opening files on different
|
||||
file systems. It can handle absolute and/or local filenames.
|
||||
It uses a system of handlers to
|
||||
It uses a system of handlers() to
|
||||
provide access to user-defined virtual file systems.
|
||||
|
||||
@library{wxbase}
|
||||
@category{vfs}
|
||||
|
||||
@seealso
|
||||
wxFileSystemHandler, wxFSFile, Overview
|
||||
@see wxFileSystemHandler, wxFSFile, Overview()
|
||||
*/
|
||||
class wxFileSystem : public wxObject
|
||||
{
|
||||
@ -31,7 +30,7 @@ public:
|
||||
|
||||
/**
|
||||
This static function adds new handler into the list of
|
||||
handlers which provide access to virtual FS.
|
||||
handlers() which provide access to virtual FS.
|
||||
Note that if two handlers for the same protocol are added, the last one added
|
||||
takes precedence.
|
||||
*/
|
||||
@ -77,7 +76,7 @@ public:
|
||||
const wxString& file);
|
||||
|
||||
/**
|
||||
Works like wxFindFirstFile. Returns name of the first
|
||||
Works like wxFindFirstFile(). Returns name of the first
|
||||
filename (within filesystem's current path) that matches @e wildcard. @a flags
|
||||
may be one of
|
||||
wxFILE (only files), wxDIR (only directories) or 0 (both).
|
||||
@ -126,6 +125,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFSFile
|
||||
@wxheader{filesys.h}
|
||||
@ -143,8 +143,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{vfs}
|
||||
|
||||
@seealso
|
||||
wxFileSystemHandler, wxFileSystem, Overview
|
||||
@see wxFileSystemHandler, wxFileSystem, Overview()
|
||||
*/
|
||||
class wxFSFile : public wxObject
|
||||
{
|
||||
@ -216,6 +215,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFileSystemHandler
|
||||
@wxheader{filesys.h}
|
||||
@ -228,7 +228,7 @@ public:
|
||||
of opening the file: GetProtocol, GetLeftLocation, GetRightLocation,
|
||||
GetAnchor, GetMimeTypeFromExt.
|
||||
|
||||
Please have a look at overview if you don't know how locations
|
||||
Please have a look at overview() if you don't know how locations
|
||||
are constructed.
|
||||
|
||||
Also consult @ref overview_fs "list of available handlers".
|
||||
@ -239,8 +239,7 @@ public:
|
||||
@library{wxbase}
|
||||
@category{vfs}
|
||||
|
||||
@seealso
|
||||
wxFileSystem, wxFSFile, Overview
|
||||
@see wxFileSystem, wxFSFile, Overview()
|
||||
*/
|
||||
class wxFileSystemHandler : public wxObject
|
||||
{
|
||||
@ -260,7 +259,7 @@ public:
|
||||
virtual bool CanOpen(const wxString& location);
|
||||
|
||||
/**
|
||||
Works like wxFindFirstFile. Returns name of the first
|
||||
Works like wxFindFirstFile(). Returns name of the first
|
||||
filename (within filesystem's current path) that matches @e wildcard. @a flags
|
||||
may be one of
|
||||
wxFILE (only files), wxDIR (only directories) or 0 (both).
|
||||
@ -324,3 +323,4 @@ public:
|
||||
virtual wxFSFile* OpenFile(wxFileSystem& fs,
|
||||
const wxString& location);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: font.h
|
||||
// Purpose: documentation for wxFont class
|
||||
// Purpose: interface of wxFont
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -29,19 +29,10 @@
|
||||
@category{gdi}
|
||||
|
||||
@stdobjects
|
||||
Objects:
|
||||
wxNullFont
|
||||
Pointers:
|
||||
wxNORMAL_FONT
|
||||
::Objects:, ::wxNullFont, ::Pointers:, ::wxNORMAL_FONT, ::wxSMALL_FONT,
|
||||
::wxITALIC_FONT, ::wxSWISS_FONT,
|
||||
|
||||
wxSMALL_FONT
|
||||
|
||||
wxITALIC_FONT
|
||||
|
||||
wxSWISS_FONT
|
||||
|
||||
@seealso
|
||||
@ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
|
||||
@see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
|
||||
wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
|
||||
*/
|
||||
class wxFont : public wxGDIObject
|
||||
@ -658,3 +649,43 @@ public:
|
||||
*/
|
||||
bool operator ==(const wxFont& font);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont Objects:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont wxNullFont;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont Pointers:
|
||||
;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont wxNORMAL_FONT;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont wxSMALL_FONT;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont wxITALIC_FONT;
|
||||
|
||||
/**
|
||||
FIXME
|
||||
*/
|
||||
wxFont wxSWISS_FONT;
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fontdlg.h
|
||||
// Purpose: documentation for wxFontDialog class
|
||||
// Purpose: interface of wxFontDialog
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -15,8 +15,7 @@
|
||||
@library{wxcore}
|
||||
@category{cmndlg}
|
||||
|
||||
@seealso
|
||||
Overview, wxFontData, wxGetFontFromUser
|
||||
@see Overview(), wxFontData, wxGetFontFromUser()
|
||||
*/
|
||||
class wxFontDialog : public wxDialog
|
||||
{
|
||||
@ -64,6 +63,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fontenum.h
|
||||
// Purpose: documentation for wxFontEnumerator class
|
||||
// Purpose: interface of wxFontEnumerator
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -13,7 +13,7 @@
|
||||
wxFontEnumerator enumerates either all available fonts on the system or only
|
||||
the ones with given attributes - either only fixed-width (suited for use in
|
||||
programs such as terminal emulators and the like) or the fonts available in
|
||||
the given encoding.
|
||||
the given encoding().
|
||||
|
||||
To do this, you just have to call one of EnumerateXXX() functions - either
|
||||
wxFontEnumerator::EnumerateFacenames or
|
||||
@ -26,9 +26,8 @@
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
@ref overview_wxfontencodingoverview, @ref overview_samplefont "Font sample",
|
||||
wxFont, wxFontMapper
|
||||
@see @ref overview_wxfontencodingoverview, @ref overview_samplefont "Font
|
||||
sample", wxFont, wxFontMapper
|
||||
*/
|
||||
class wxFontEnumerator
|
||||
{
|
||||
@ -83,3 +82,4 @@ public:
|
||||
virtual bool OnFontEncoding(const wxString& font,
|
||||
const wxString& encoding);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fontmap.h
|
||||
// Purpose: documentation for wxFontMapper class
|
||||
// Purpose: interface of wxFontMapper
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -31,8 +31,7 @@
|
||||
@library{wxcore}
|
||||
@category{misc}
|
||||
|
||||
@seealso
|
||||
wxEncodingConverter, @ref overview_nonenglishoverview "Writing non-English
|
||||
@see wxEncodingConverter, @ref overview_nonenglishoverview "Writing non-English
|
||||
applications"
|
||||
*/
|
||||
class wxFontMapper
|
||||
@ -174,3 +173,4 @@ public:
|
||||
*/
|
||||
void SetDialogTitle(const wxString& title);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fontpicker.h
|
||||
// Purpose: documentation for wxFontPickerCtrl class
|
||||
// Purpose: interface of wxFontPickerCtrl
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -40,8 +40,7 @@
|
||||
@category{miscpickers}
|
||||
@appearance{fontpickerctrl.png}
|
||||
|
||||
@seealso
|
||||
wxFontDialog, wxFontPickerEvent
|
||||
@see wxFontDialog, wxFontPickerEvent
|
||||
*/
|
||||
class wxFontPickerCtrl : public wxPickerBase
|
||||
{
|
||||
@ -119,6 +118,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFontPickerEvent
|
||||
@wxheader{fontpicker.h}
|
||||
@ -129,8 +129,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxFontPickerCtrl
|
||||
@see wxFontPickerCtrl
|
||||
*/
|
||||
class wxFontPickerEvent : public wxCommandEvent
|
||||
{
|
||||
@ -151,3 +150,4 @@ public:
|
||||
*/
|
||||
void SetFont(const wxFont& f);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: frame.h
|
||||
// Purpose: documentation for wxFrame class
|
||||
// Purpose: interface of wxFrame
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -82,8 +82,7 @@
|
||||
@library{wxcore}
|
||||
@category{managedwnd}
|
||||
|
||||
@seealso
|
||||
wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog
|
||||
@see wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog
|
||||
*/
|
||||
class wxFrame : public wxTopLevelWindow
|
||||
{
|
||||
@ -380,3 +379,4 @@ public:
|
||||
*/
|
||||
void SetToolBar(wxToolBar* toolBar);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: fs_mem.h
|
||||
// Purpose: documentation for wxMemoryFSHandler class
|
||||
// Purpose: interface of wxMemoryFSHandler
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -61,8 +61,7 @@
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxMemoryFSHandler::AddFileWithMimeType
|
||||
@see wxMemoryFSHandler::AddFileWithMimeType
|
||||
*/
|
||||
class wxMemoryFSHandler : public wxFileSystemHandler
|
||||
{
|
||||
@ -81,7 +80,7 @@ public:
|
||||
The @a type argument is one of @c wxBITMAP_TYPE_XXX constants.
|
||||
Note that you must use a @a type value (aka image format)
|
||||
that wxWidgets can save (e.g. JPG, PNG, see wxImage
|
||||
documentation)!
|
||||
documentation())!
|
||||
|
||||
@see AddFileWithMimeType()
|
||||
*/
|
||||
@ -97,7 +96,8 @@ 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.
|
||||
This function is new since wxWidgets version 2.8.5
|
||||
|
||||
@wxsince{2.8.5}
|
||||
|
||||
@see AddFile()
|
||||
*/
|
||||
@ -115,3 +115,4 @@ public:
|
||||
*/
|
||||
static void RemoveFile(const wxString& filename);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: gauge.h
|
||||
// Purpose: documentation for wxGauge class
|
||||
// Purpose: interface of wxGauge
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -40,8 +40,7 @@
|
||||
@category{ctrl}
|
||||
@appearance{gauge.png}
|
||||
|
||||
@seealso
|
||||
wxSlider, wxScrollBar
|
||||
@see wxSlider, wxScrollBar
|
||||
*/
|
||||
class wxGauge : public wxControl
|
||||
{
|
||||
@ -179,3 +178,4 @@ public:
|
||||
*/
|
||||
void SetValue(int pos);
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: gbsizer.h
|
||||
// Purpose: documentation for wxGBPosition class
|
||||
// Purpose: interface of wxGBPosition
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -60,6 +60,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxGridBagSizer
|
||||
@wxheader{gbsizer.h}
|
||||
@ -220,6 +221,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxGBSizerItem
|
||||
@wxheader{gbsizer.h}
|
||||
@ -304,6 +306,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxGBSpan
|
||||
@wxheader{gbsizer.h}
|
||||
@ -357,3 +360,4 @@ public:
|
||||
*/
|
||||
bool operator operator==(const wxGBSpan& o) const;
|
||||
};
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: gdicmn.h
|
||||
// Purpose: documentation for wxRealPoint class
|
||||
// Purpose: interface of wxRealPoint
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
@ -17,8 +17,7 @@
|
||||
@library{wxcore}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
wxPoint
|
||||
@see wxPoint
|
||||
*/
|
||||
class wxRealPoint
|
||||
{
|
||||
@ -36,6 +35,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxRect
|
||||
@wxheader{gdicmn.h}
|
||||
@ -45,8 +45,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
wxPoint, wxSize
|
||||
@see wxPoint, wxSize
|
||||
*/
|
||||
class wxRect
|
||||
{
|
||||
@ -324,6 +323,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxBrushList
|
||||
@wxheader{gdicmn.h}
|
||||
@ -333,8 +333,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{gdi}
|
||||
|
||||
@seealso
|
||||
wxBrush
|
||||
@see wxBrush
|
||||
*/
|
||||
class wxBrushList : public wxList
|
||||
{
|
||||
@ -360,6 +359,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPoint
|
||||
@wxheader{gdicmn.h}
|
||||
@ -372,8 +372,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
wxRealPoint
|
||||
@see wxRealPoint
|
||||
*/
|
||||
class wxPoint
|
||||
{
|
||||
@ -419,6 +418,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxColourDatabase
|
||||
@wxheader{gdicmn.h}
|
||||
@ -436,8 +436,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{FIXME}
|
||||
|
||||
@seealso
|
||||
wxColour
|
||||
@see wxColour
|
||||
*/
|
||||
class wxColourDatabase
|
||||
{
|
||||
@ -474,6 +473,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxFontList
|
||||
@wxheader{gdicmn.h}
|
||||
@ -491,8 +491,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{gdi}
|
||||
|
||||
@seealso
|
||||
wxFont
|
||||
@see wxFont
|
||||
*/
|
||||
class wxFontList : public wxList
|
||||
{
|
||||
@ -516,6 +515,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxSize
|
||||
@wxheader{gdicmn.h}
|
||||
@ -535,8 +535,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{data}
|
||||
|
||||
@seealso
|
||||
wxPoint, wxRealPoint
|
||||
@see wxPoint, wxRealPoint
|
||||
*/
|
||||
class wxSize
|
||||
{
|
||||
@ -666,6 +665,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxPenList
|
||||
@wxheader{gdicmn.h}
|
||||
@ -700,8 +700,7 @@ public:
|
||||
@library{wxcore}
|
||||
@category{gdi}
|
||||
|
||||
@seealso
|
||||
wxPen
|
||||
@see wxPen
|
||||
*/
|
||||
class wxPenList
|
||||
{
|
||||
@ -735,6 +734,7 @@ public:
|
||||
};
|
||||
|
||||
|
||||
|
||||
// ============================================================================
|
||||
// Global functions/macros
|
||||
// ============================================================================
|
||||
@ -772,7 +772,7 @@ wxSize wxGetDisplaySizeMM();
|
||||
for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
|
||||
avoid using @c #ifdefs when creating icons.
|
||||
|
||||
@see @ref overview_wxbitmapoverview, wxBITMAP
|
||||
@see @ref overview_wxbitmapoverview, wxBITMAP()
|
||||
*/
|
||||
wxICON();
|
||||
|
||||
@ -786,7 +786,7 @@ bool wxColourDisplay();
|
||||
for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
|
||||
avoid using @c #ifdefs when creating bitmaps.
|
||||
|
||||
@see @ref overview_wxbitmapoverview, wxICON
|
||||
@see @ref overview_wxbitmapoverview, wxICON()
|
||||
*/
|
||||
#define wxBITMAP() /* implementation is private */
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user