# aliases for additional wx-specific infos
ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
+ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
@defgroup group_class_appmanagement Application and Process Management
@ingroup group_class
-The classes in this section are used to handle application-wide settings or
-for initialization/shutdown of the application itself.
+The classes in this section represent the application (see wxApp) or parts of it
+(e.g. wxEventLoopBase, wxModule).
+They can be used for initialization/shutdown of the application itself.
Related macros/global-functions group: @ref group_funcmacro_appinitterm.
--- /dev/null
+/////////////////////////////////////////////////////////////////////////////
+// Name: class_bookctrl.h
+// Purpose: Book controls classes group docs
+// Author: wxWidgets team
+// RCS-ID: $Id$
+// Licence: wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_class_bookctrl Book Controls
+@ingroup group_class
+
+A book control contains pages of other controls.
+
+Related overview: @ref overview_bookctrl
+
+*/
+
--- /dev/null
+/////////////////////////////////////////////////////////////////////////////
+// Name: class_cfg.h
+// Purpose: Application and System configuration classes group docs
+// Author: wxWidgets team
+// RCS-ID: $Id$
+// Licence: wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_class_cfg Application and System configuration
+@ingroup group_class
+
+The classes in this section are used to handle application-wide settings
+and system-wide settings.
+
+*/
+
@ingroup group_class
These are the data structure classes provided by wxWidgets.
+Some of them are used to store generic data (e.g. wxPoint, wxSize, etc),
+others are mainly helpers of other classes (e.g. wxListItem, wxCalendarDateAttr,
+wxFindReplaceDialogData, etc).
*/
so you should avoid specifying these fields to achieve more native look and feel.
@library{wxadv}
- @category{misc}
+ @category{cmndlg,data}
@see wxAboutDialogInfo::SetArtists
*/
(see wxAcceleratorTable).
@library{wxcore}
- @category{misc}
+ @category{data}
@see wxAcceleratorTable, wxWindow::SetAcceleratorTable
*/
'OK'.
@library{wxcore}
- @category{misc}
+ @category{data}
@stdobjects
::wxNullAcceleratorTable
implementation of the wxAppTraits interface.
@library{wxbase}
- @category{appmanagement}
+ @category{cfg}
@see @ref overview_app, wxApp
*/
identical bitmap for different client values!
@library{wxcore}
- @category{misc,data}
+ @category{misc}
@see the @ref page_samples_artprov for an example of wxArtProvider usage.
*/
wxBitmap class documentation.
@library{wxcore}
- @category{misc}
+ @category{gdi}
@see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor
*/
This is a pure virtual class so you cannot allocate it directly.
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@see @ref overview_bookctrl
*/
probably unnecessary to process both events at once.
@library{wxcore}
- @category{events}
+ @category{events,bookctrl}
@see wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
*/
@todo provide better docs for this class
+ @tparam T
+ The type of the characters stored in this class.
+
@nolibrary
- @category{misc}
+ @category{data}
*/
template <typename T>
class wxCharTypeBuffer
@todo provide better docs for this class
@nolibrary
- @category{misc}
+ @category{data}
*/
class wxCharBuffer : public wxCharTypeBuffer<char>
{
This class is available only when <tt>wxUSE_WCHAR_T==1</tt>
@nolibrary
- @category{misc}
+ @category{data}
*/
class wxWCharBuffer : public wxCharTypeBuffer<wchar_t>
{
wxWCharBuffer(const wxCStrData& cstr);
};
-
-
/**
@class wxMemoryBuffer
of this class are used with wxCalendarCtrl.
@library{wxadv}
- @category{misc}
+ @category{data}
@see wxCalendarCtrl
*/
@endEventTable
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@appearance{choicebook.png}
@see @ref overview_bookctrl, wxNotebook, @ref page_samples_notebook
This class holds a variety of information related to font dialogs.
@library{wxcore}
- @category{cmndlg}
+ @category{cmndlg,data}
@see @ref overview_cmndlg_font, wxFont, wxFontDialog
*/
stored by wxPageSetupDialogData).
@library{wxcore}
- @category{printing}
+ @category{printing,data}
@see @ref overview_printing, wxPageSetupDialog
*/
This class holds a variety of information related to colour dialogs.
@library{wxcore}
- @category{cmndlg}
+ @category{cmndlg,data}
@see wxColour, wxColourDialog, @ref overview_cmndlg_colour
*/
@endcode
@library{wxcore}
- @category{printing}
+ @category{printing,data}
@see @ref overview_printing, wxPrintDialog, wxPageSetupDialog,
wxPrintDialogData, wxPageSetupDialogData, @ref overview_cmndlg_print,
settings.
@library{wxcore}
- @category{printing}
+ @category{printing,cmndlg,data}
@see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print
*/
@library{wxbase}
- @category{misc}
+ @category{cfg}
*/
class wxConfigBase : public wxObject
{
@todo Write wxDateTimeHolidayAuthority documentation.
@library{wxbase}
- @category{misc}
+ @category{data}
*/
class wxDateTimeHolidayAuthority
{
Determines the sizes and locations of displays connected to the system.
@library{wxcore}
- @category{misc}
+ @category{cfg}
@see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
*/
@c wxFONTENCODING_KOI8.
@note
-
Please use wxMBConv classes instead if possible. wxCSConv has much better
support for various encodings than wxEncodingConverter.
wxEncodingConverter is useful only if you rely on wxCONVERT_SUBSTITUTE mode
of operation (see wxEncodingConverter::Init()).
@library{wxbase}
- @category{misc}
+ @category{conv}
@see wxFontMapper, wxMBConv, @ref overview_nonenglish
*/
(unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
@library{wxcore}
- @category{events}
+ @category{events,threading}
@see @ref overview_thread, wxEventLoopBase::YieldFor
*/
dialog and calling them has no effect later.
@library{wxcore}
- @category{data}
+ @category{cmndlg,data}
*/
class wxFindReplaceData : public wxObject
{
Windows.
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see wxFileConfig::Save
*/
@endEventTable
@library{wxbase}
- @category{miscwnd}
+ @category{ctrl}
@appearance{filectrl.png}
@nativeimpl{wxgtk}
@see wxGenericDirCtrl
*/
-class wxFileCtrl : public wxWindow
+class wxFileCtrl : public wxControl
{
public:
wxFileCtrl();
@endcode
@library{wxcore}
- @category{misc}
+ @category{cfg}
- @see wxEncodingConverter, @ref overview_nonenglish "Writing non-English applications"
+ @see wxEncodingConverter, @ref overview_nonenglish
*/
class wxFontMapper
{
Event class representing the events generated by wxHeaderCtrl.
@library{wxcore}
- @category{ctrl}
+ @category{events}
@see wxHeaderCtrl
*/
::wxNullImage
@library{wxcore}
- @category{misc}
+ @category{gdi}
@see wxImage, wxInitAllImageHandlers()
*/
If the image has an alpha channel, all pixels with alpha value less
than @a threshold are replaced with the mask colour and the alpha
channel is removed. Otherwise nothing is done.
-
+
The mask colour is chosen automatically using
FindFirstUnusedColour() by this function, see the overload below if you
this is not appropriate.
considered to be opaque.
*/
- void ConvertAlphaToMask(unsigned char mr, unsigned char mg, unsigned char mb,
+ void ConvertAlphaToMask(unsigned char mr, unsigned char mg, unsigned char mb,
unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);
//@}
@endWxPerlOnly
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see @ref overview_i18n, @ref page_samples_internat, wxXLocale
*/
The type stored in the wxList nodes.
@library{wxbase}
- @category{data}
+ @category{containers}
@see wxArray<T>, wxVector<T>, wxNode<T>
*/
@endEventTable
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@appearance{listbook.png}
@see wxBookCtrl, wxNotebook, @ref page_samples_notebook
Represents the attributes (color, font, ...) of a wxListCtrl's wxListItem.
@library{wxbase}
- @category{ctrl}
+ @category{data}
@see @ref overview_listctrl, wxListCtrl, wxListItem
*/
If the colour/font is not specified, the default list control colour/font is used.
@library{wxbase}
- @category{ctrl}
+ @category{data}
@see wxListCtrl
*/
@onlyfor{wxmsw}
@library{wxcore}
- @category{gdi,misc}
+ @category{gdi}
@see wxMetafileDC
*/
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see wxFileType
*/
@library{wxbase}
- @category{misc}
+ @category{data}
@see wxMimeTypesManager
*/
@endcode
@library{wxbase}
- @category{misc}
+ @category{appmanagement}
*/
class wxModule : public wxObject
{
/////////////////////////////////////////////////////////////////////////////
/**
-
wxMessageQueue allows passing messages between threads.
This class should be typically used to communicate between the main and worker
threads. The main thread calls wxMessageQueue::Post and the worker thread
calls wxMessageQueue::Receive.
- For this class a message is an object of arbitrary type T.
+ @tparam T
+ For this class a message is an object of arbitrary type T.
+
Notice that often there is a some special message indicating that the thread
should terminate as there is no other way to gracefully shutdown a thread
waiting on the message queue.
@nolibrary
- @category{misc}
+ @category{threading}
@see wxThread
*/
+template <typename T>
class wxMessageQueue<T>
{
public:
@onlyfor{wxmsw}
@library{wxbase}
- @category{misc,ipc}
+ @category{ctrl,ipc}
@see wxActiveXEvent, @ref page_samples_flash
*/
@onlyfor{wxmsw}
@library{wxcore}
- @category{misc}
+ @category{data}
@see wxVariant
*/
@onlyfor{wxmsw}
- @library{wxbase}
- @category{misc}
-
@b Example:
@code
key->GetNextKey(key_name, 1);
}
@endcode
+
+
+ @library{wxbase}
+ @category{cfg}
*/
class wxRegKey
{
*/
wxRegKey(const wxString& strKey);
/**
- The constructor to set the full name of the key using one of the
+ The constructor to set the full name of the key using one of the
standard keys, that is, HKCR, HKCU, HKLM, HKUSR, HKPD, HKCC or HKDD.
*/
wxRegKey(StdKey keyParent, const wxString& strKey);
Write ///< Read and Write
};
- /**
+ /**
The standard registry key enumerator.
*/
enum StdKey
Type_Multi_String, ///< Multiple Unicode strings
Type_Resource_list, ///< Resource list in the resource map
Type_Full_resource_descriptor, ///< Resource list in the hardware description
- Type_Resource_requirements_list ///<
+ Type_Resource_requirements_list ///<
};
/**
using the key. Returns @true if successful.
*/
bool Copy(wxRegKey& keyDst);
-
+
/**
Copy the value to another key, possibly changing its name. By default
it will remain the same. Returns @true if successful.
*/
- bool CopyValue(const wxString& szValue, wxRegKey& keyDst,
+ bool CopyValue(const wxString& szValue, wxRegKey& keyDst,
const wxString& szNewName = wxEmptyString);
/**
Creates the key. Will fail if the key already exists and @a bOkIfExists
void DeleteSelf();
/**
- Deletes the named value or use an empty string argument to remove the
+ Deletes the named value or use an empty string argument to remove the
default value of the key.
*/
void DeleteValue(const wxString& szKey);
Returns @true if successful.
*/
bool Export(wxOutputStream& ostr) const;
-
+
/**
Gets the first key. Returns @true if successful.
*/
Gets the value type.
*/
ValueType GetValueType(const wxString& szValue) const;
-
+
/**
Returns @true if given subkey exists.
*/
/**
Preallocate some memory for the name. For wxRegConfig usage only.
*/
- void ReserveMemoryForName(size_t bytes);
+ void ReserveMemoryForName(size_t bytes);
/**
Set or change the HKEY handle.
*/
void SetHkey(WXHKEY hKey);
-
+
/**
Set the full key name. The name is absolute. It should start with
HKEY_xxx.
Set the name relative to the parent key
*/
void SetName(const wxRegKey& keyParent, const wxString& strKey);
-
+
/**
Sets the given @a szValue which must be numeric. If the value doesn't
exist, it is created. Returns @true if successful.
*/
bool SetValue(const wxString& szValue, const wxString& strValue);
/**
- Sets the given @a szValue which must be binary. If the value doesn't
+ Sets the given @a szValue which must be binary. If the value doesn't
exist, it is created. Returns @true if successful.
*/
bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@appearance{notebook.png}
@see wxBookCtrl, wxBookCtrlEvent, wxImageList, @ref page_samples_notebook
where it's running.
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(),
wxAppTraits
and user interface element sizes.
@library{wxcore}
- @category{misc}
+ @category{cfg}
@see wxFont, wxColour
*/
system call, but almost all of modern Unix systems do) only.
@library{wxbase}
- @category{misc}
+ @category{appmanagement}
*/
class wxSingleInstanceChecker
{
Open Sound System or Simple DirectMedia Layer).
@library{wxadv}
- @category{misc}
+ @category{media}
*/
class wxSound : public wxObject
{
@todo list styled text ctrl events.
@library{wxbase}
- @category{events}
+ @category{events,stc}
*/
class wxStyledTextEvent : public wxCommandEvent
{
The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see wxSystemSettings
*/
@endEventTable
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook,
@ref page_samples_notebook
An opaque reference to a tree item.
@library{wxcore}
- @category{misc}
+ @category{data}
@see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
*/
@endEventTable
@library{wxcore}
- @category{miscwnd}
+ @category{bookctrl}
@see wxBookCtrl, wxBookCtrlEvent, wxNotebook, wxTreeCtrl, wxImageList,
@ref overview_bookctrl, @ref page_samples_notebook
Determines the sizes and locations of displays connected to the system.
@library{wxcore}
- @category{misc}
+ @category{cfg}
@stdobjects
::wxDefaultVideoMode
and can also be used be used directly.
@library{wxcore}
- @category{misc}
+ @category{cfg}
@see wxWindow::NewControlId(), wxWindow::UnreserveControlId(),
@ref overview_windowids
IO) in the near future.
@library{wxbase}
- @category{misc}
+ @category{cfg}
@see wxLocale
*/
projects / wxWidgets.git / commitdiff
