git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28164
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
12 files changed:
sometimes called {\it light-weight processes}, but the fundamental difference
between threads and processes is that memory spaces of different processes are
separated while all threads share the same address space. While it makes it
sometimes called {\it light-weight processes}, but the fundamental difference
between threads and processes is that memory spaces of different processes are
separated while all threads share the same address space. While it makes it
-much easier to share common data between several threads, it also makes much
+much easier to share common data between several threads, it also makes it much
easier to shoot oneself in the foot, so careful use of synchronization objects
such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcriticalsection} is recommended.
easier to shoot oneself in the foot, so careful use of synchronization objects
such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcriticalsection} is recommended.
\end{twocollist}
Finally, it might be helpful to do a search in the entire sample directory if
\end{twocollist}
Finally, it might be helpful to do a search in the entire sample directory if
-you can't find the sample you showing the control you are interested in by
-name. Most of wxWidgets classes, occur in at least one of the samples.
+you can't find the sample showing the control you are interested in by
+name. Most classes contained in wxWidgets occur in at least one of the samples.
\subsection{Minimal sample}\label{sampleminimal}
\subsection{Minimal sample}\label{sampleminimal}
This sample demonstrates the use of the \helpref{wxCheckListBox}{wxchecklistbox}
class intercepting check, select and double click events. It also tests the
use of various methods modifying the control, such as by deleting items
This sample demonstrates the use of the \helpref{wxCheckListBox}{wxchecklistbox}
class intercepting check, select and double click events. It also tests the
use of various methods modifying the control, such as by deleting items
-from it or inserting new once (these functions are actually implemented in
+from it or inserting new ones (these functions are actually implemented in
the parent class \helpref{wxListBox}{wxlistbox} so the sample tests that class
as well). The layout of the dialog is created using a \helpref{wxBoxSizer}{wxboxsizer}
demonstrating a simple dynamic layout.
the parent class \helpref{wxListBox}{wxlistbox} so the sample tests that class
as well). The layout of the dialog is created using a \helpref{wxBoxSizer}{wxboxsizer}
demonstrating a simple dynamic layout.
The controls sample is the main test program for most simple controls used in
wxWidgets. The sample tests their basic functionality, events, placement,
modification in terms of colour and font as well as the possibility to change
The controls sample is the main test program for most simple controls used in
wxWidgets. The sample tests their basic functionality, events, placement,
modification in terms of colour and font as well as the possibility to change
-the controls programmatically, such as adding item to a list box etc. Apart
+the controls programmatically, such as adding an item to a list box etc. Apart
from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
features of this special control (using bitmap in the tabs, using
\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
features of this special control (using bitmap in the tabs, using
\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
\subsection{Dialogs sample}\label{sampledialogs}
This sample shows how to use the common dialogs available from wxWidgets. These
\subsection{Dialogs sample}\label{sampledialogs}
This sample shows how to use the common dialogs available from wxWidgets. These
-dialogs are described in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
+dialogs are described in detail in the \helpref{Common dialogs overview}{commondialogsoverview}.
\subsection{Dialup sample}\label{sampledialup}
\subsection{Dialup sample}\label{sampledialup}
-This sample shows \helpref{wxDialUpManager}{wxdialupmanager}
+This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
class. It displays in the status bar the information gathered through its
interface: in particular, the current connection status (online or offline) and
whether the connection is permanent (in which case a string `LAN' appears in
class. It displays in the status bar the information gathered through its
interface: in particular, the current connection status (online or offline) and
whether the connection is permanent (in which case a string `LAN' appears in
-the third status bar field - but note that you may have be on a LAN not
+the third status bar field - but note that you may be on a LAN not
connected to the Internet, in which case you will not see this) or not.
Using the menu entries, you may also dial or hang up the line if you have a
connected to the Internet, in which case you will not see this) or not.
Using the menu entries, you may also dial or hang up the line if you have a
Finally, the last part is used for dragging text from it to either one of the
listboxes (only one will accept it) or another application. The last
functionality available from the main frame is to paste a bitmap from the
Finally, the last part is used for dragging text from it to either one of the
listboxes (only one will accept it) or another application. The last
functionality available from the main frame is to paste a bitmap from the
-clipboard (or, in the case of Windows version, also a metafile) - it will be
+clipboard (or, in the case of the Windows version, also a metafile) - it will be
shown in a new frame.
So far, everything we mentioned was implemented with minimal amount of code
shown in a new frame.
So far, everything we mentioned was implemented with minimal amount of code
This sample is a very small sample that demonstrates the use of the
\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
This sample is a very small sample that demonstrates the use of the
\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
-should be used whenever it is not known at compile time, which control
+should be used whenever it is not known at compile time which control
will receive which event or which controls are actually going to be in
a dialog or frame. This is most typically the case for any scripting
language that would work as a wrapper for wxWidgets or programs where
will receive which event or which controls are actually going to be in
a dialog or frame. This is most typically the case for any scripting
language that would work as a wrapper for wxWidgets or programs where
-forms or similar datagrams can be created by the uses.
+forms or similar datagrams can be created by the users.
See also the \helpref{event sample}{sampleevent}
See also the \helpref{event sample}{sampleevent}
understand what goes on.
You need to build the library with \texttt{wxUSE\_EXCEPTIONS} being set to $1$
understand what goes on.
You need to build the library with \texttt{wxUSE\_EXCEPTIONS} being set to $1$
-and compile your code with the C++ exceptions support to be able to build this
+and compile your code with C++ exceptions support to be able to build this
\subsection{HTML samples}\label{samplehtml}
Eight HTML samples (you can find them in directory {\tt samples/html})
\subsection{HTML samples}\label{samplehtml}
Eight HTML samples (you can find them in directory {\tt samples/html})
-cover all features of HTML sub-library.
+cover all features of the HTML sub-library.
{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
-and also shows most of supported HTML tags.
+and also shows most supported HTML tags.
-{\bf Widget} shows how you can embed ordinary controls or windows within
+{\bf Widget} shows how you can embed ordinary controls or windows within an
HTML page. It also nicely explains how to write new tag handlers and extend
the library to work with unsupported tags.
HTML page. It also nicely explains how to write new tag handlers and extend
the library to work with unsupported tags.
-{\bf About} may give you an idea how to write good-looking about boxes.
+{\bf About} may give you an idea how to write good-looking About boxes.
{\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
handler (ships with wxWidgets) allows you to access HTML pages stored
{\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
handler (ships with wxWidgets) allows you to access HTML pages stored
-in compressed archive as if they were ordinary files.
+in a compressed archive as if they were ordinary files.
{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application.
{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application.
{\bf Help} and {\bf Helpview} are variations on displaying HTML help
(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
{\bf Help} and {\bf Helpview} are variations on displaying HTML help
(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
-while {\it Helpview} is simple tool that only pops up help window and
+while {\it Helpview} is a simple tool that only pops up the help window and
displays help books given at command line.
displays help books given at command line.
The image sample demonstrates the use of the \helpref{wxImage}{wximage} class
and shows how to download images in a variety of formats, currently PNG, GIF,
The image sample demonstrates the use of the \helpref{wxImage}{wximage} class
and shows how to download images in a variety of formats, currently PNG, GIF,
-TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows to rectangles, one
+TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
of which is drawn directly in the window, the other one is drawn into a
\helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image
and then reloaded from the PNG file again so that conversions between wxImage
of which is drawn directly in the window, the other one is drawn into a
\helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image
and then reloaded from the PNG file again so that conversions between wxImage
-and wxBitmap as well as loading and save PNG files are tested.
+and wxBitmap as well as loading and saving PNG files are tested.
-At the bottom of the main frame is a test for using a monochrome bitmap by
+At the bottom of the main frame there is a test for using a monochrome bitmap by
drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
specifying the foreground and background colours with
\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
specifying the foreground and background colours with
\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
\subsection{Internat(ionalization) sample}\label{sampleinternat}
The not very clearly named internat sample demonstrates the wxWidgets
\subsection{Internat(ionalization) sample}\label{sampleinternat}
The not very clearly named internat sample demonstrates the wxWidgets
-internatationalization (i18n for short from now on) features. To be more
+internationalization (i18n for short from now on) features. To be more
precise, it only shows localization support, i.e. support for translating the
program messages in another language while true i18n would also involve
changing the other aspects of the programs behaviour.
precise, it only shows localization support, i.e. support for translating the
program messages in another language while true i18n would also involve
changing the other aspects of the programs behaviour.
\subsection{Listctrl sample}\label{samplelistctrl}
\subsection{Listctrl sample}\label{samplelistctrl}
-This sample shows \helpref{wxListCtrl}{wxlistctrl} control. Different modes
+This sample shows the \helpref{wxListCtrl}{wxlistctrl} control. Different modes
supported by the control (list, icons, small icons, report) may be chosen from
the menu.
supported by the control (list, icons, small icons, report) may be chosen from
the menu.
The server binds to the local address, using TCP port number 3000,
sets up an event handler to be notified of incoming connection requests
The server binds to the local address, using TCP port number 3000,
sets up an event handler to be notified of incoming connection requests
-({\bf wxSOCKET\_CONNECTION} events), and stands there, waiting for clients
+({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients
({\it listening} in the socket parlance). For each accepted connection,
a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
socket objects are independent from the server that created them, so
({\it listening} in the socket parlance). For each accepted connection,
a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
socket objects are independent from the server that created them, so
to catch {\bf wxSOCKET\_LOST} events, each one is immediately notified
if the other end closes the connection.
to catch {\bf wxSOCKET\_LOST} events, each one is immediately notified
if the other end closes the connection.
-There is also an URL test which shows how to use
+There is also a URL test which shows how to use
the \helpref{wxURL}{wxurl} class to fetch data from a given URL.
The sockets sample is work in progress. Some things to do:
the \helpref{wxURL}{wxurl} class to fetch data from a given URL.
The sockets sample is work in progress. Some things to do:
\end{itemize}
Some buttons in the main toolbar are check buttons, i.e. they stay checked when
\end{itemize}
Some buttons in the main toolbar are check buttons, i.e. they stay checked when
-pressed. On the platforms which support it, the sample also add a combobox
+pressed. On the platforms which support it, the sample also adds a combobox
to the toolbar showing how you can use arbitrary controls and not only buttons
in it.
If you toggle another toolbar in the sample (using {\tt Ctrl-A}) you will also
see the radio toolbar buttons in action: the first three buttons form a radio
to the toolbar showing how you can use arbitrary controls and not only buttons
in it.
If you toggle another toolbar in the sample (using {\tt Ctrl-A}) you will also
see the radio toolbar buttons in action: the first three buttons form a radio
-group, that is checking any of them automatically unchecks the previously
+group, i.e. checking any of them automatically unchecks the previously
continuing).
\item Using more elaborated techniques to allow returning to the previous
page, but not continuing to the next one or vice versa (in wxRadioboxPage)
continuing).
\item Using more elaborated techniques to allow returning to the previous
page, but not continuing to the next one or vice versa (in wxRadioboxPage)
-\item This (wxRadioboxPage) page also shows how the page may process {\tt
+\item This (wxRadioboxPage) page also shows how the page may process the {\tt
Cancel} button itself instead of relying on the wizard parent to do it.
\item Normally, the order of the pages in the wizard is known at compile-time,
but sometimes it depends on the user choices: wxCheckboxPage shows how to
Cancel} button itself instead of relying on the wizard parent to do it.
\item Normally, the order of the pages in the wizard is known at compile-time,
but sometimes it depends on the user choices: wxCheckboxPage shows how to
\section{\class{wxWindow}}\label{wxwindow}
\section{\class{wxWindow}}\label{wxwindow}
-wxWindow is the base class for all windows and represents any visible objecto n
+wxWindow is the base class for all windows and represents any visible object on
screen. All controls, top level windows and so on are windows. Sizers and
device contexts are not, however, as they don't appear on screen themselves.
screen. All controls, top level windows and so on are windows. Sizers and
device contexts are not, however, as they don't appear on screen themselves.
// class OnInit() to do it.
virtual bool OnInit();
// class OnInit() to do it.
virtual bool OnInit();
- // this is here only temproary hopefully (FIXME)
+ // this is here only temporary hopefully (FIXME)
virtual bool OnInitGui() { return true; }
// This is the replacement for the normal main(): all program work should
virtual bool OnInitGui() { return true; }
// This is the replacement for the normal main(): all program work should
// for them wouldn't work (it needs to do a copy of the event)
virtual wxEvent *Clone() const = 0;
// for them wouldn't work (it needs to do a copy of the event)
virtual wxEvent *Clone() const = 0;
- // Implementation only: this test is explicitlty anti OO and this functions
+ // Implementation only: this test is explicitly anti OO and this function
// exists only for optimization purposes.
bool IsCommandEvent() const { return m_isCommandEvent; }
// exists only for optimization purposes.
bool IsCommandEvent() const { return m_isCommandEvent; }
// ----------------
// check whether a regular file by this name exists
static bool Exists(const wxChar *name);
// ----------------
// check whether a regular file by this name exists
static bool Exists(const wxChar *name);
- // check whetther we can access the given file in given mode
+ // check whether we can access the given file in given mode
// (only read and write make sense here)
static bool Access(const wxChar *name, OpenMode mode);
// (only read and write make sense here)
static bool Access(const wxChar *name, OpenMode mode);
#undef wxCRITSECT_IS_MUTEX
// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
#undef wxCRITSECT_IS_MUTEX
// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
class WXDLLIMPEXP_BASE wxCriticalSectionLocker
{
public:
class WXDLLIMPEXP_BASE wxCriticalSectionLocker
{
public:
};
// ----------------------------------------------------------------------------
};
// ----------------------------------------------------------------------------
-// wxThread: class encpasulating a thread of execution
+// wxThread: class encapsulating a thread of execution
// ----------------------------------------------------------------------------
// there are two different kinds of threads: joinable and detached (default)
// ----------------------------------------------------------------------------
// there are two different kinds of threads: joinable and detached (default)
// is this window a top level one?
virtual bool IsTopLevel() const;
// is this window a top level one?
virtual bool IsTopLevel() const;
- // it doesn't really change parent, use ReParent() instead
+ // it doesn't really change parent, use Reparent() instead
void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
// change the real parent of this window, return true if the parent
// was changed, false otherwise (error or newParent == oldParent)
void SetParent( wxWindowBase *parent ) { m_parent = (wxWindow *)parent; }
// change the real parent of this window, return true if the parent
// was changed, false otherwise (error or newParent == oldParent)
wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
#ifdef __WXWINCE__
wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
#ifdef __WXWINCE__
+ DWORD bytesWritten = 0;
- if (WriteFile((HANDLE) m_fd, pBuf, (DWORD) nCount, & bytesRead, NULL))
- iRc = bytesRead;
+ if (WriteFile((HANDLE) m_fd, pBuf, (DWORD) nCount, & bytesWritten, NULL))
+ iRc = bytesWritten;
else
iRc = -1;
#elif defined(__MWERKS__)
else
iRc = -1;
#elif defined(__MWERKS__)
{
// NOTE: Apparently older versions (NT 4?) of the common controls send
// BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
{
// NOTE: Apparently older versions (NT 4?) of the common controls send
// BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
- // buttons, so in order to send two EVET_BUTTON events we should
+ // buttons, so in order to send two EVT_BUTTON events we should
// catch both types. Currently (Feb 2003) up-to-date versions of
// win98, win2k and winXP all send two BN_CLICKED messages for
// all button types, so we don't catch BN_DOUBLECLICKED anymore
// catch both types. Currently (Feb 2003) up-to-date versions of
// win98, win2k and winXP all send two BN_CLICKED messages for
// all button types, so we don't catch BN_DOUBLECLICKED anymore
WXLRESULT wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
WXLRESULT wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
- // when we receive focus, we want to temporary become the default button in
+ // when we receive focus, we want to temporarily become the default button in
// our parent panel so that pressing "Enter" would activate us -- and when
// losing it we should restore the previous default button as well
if ( nMsg == WM_SETFOCUS )
// our parent panel so that pressing "Enter" would activate us -- and when
// losing it we should restore the previous default button as well
if ( nMsg == WM_SETFOCUS )
m_hDC = win->GetHDC();
m_glContext = wglCreateContext((HDC) m_hDC);
m_hDC = win->GetHDC();
m_glContext = wglCreateContext((HDC) m_hDC);
- wxCHECK_RET( m_glContext, wxT("Couldn't create OpenGl context") );
+ wxCHECK_RET( m_glContext, wxT("Couldn't create OpenGL context") );
wglMakeCurrent((HDC) m_hDC, m_glContext);
}
wglMakeCurrent((HDC) m_hDC, m_glContext);
}
m_hDC = win->GetHDC();
m_glContext = wglCreateContext((HDC) m_hDC);
m_hDC = win->GetHDC();
m_glContext = wglCreateContext((HDC) m_hDC);
- wxCHECK_RET( m_glContext, wxT("Couldn't create OpenGl context") );
+ wxCHECK_RET( m_glContext, wxT("Couldn't create OpenGL context") );
if( other != 0 )
wglShareLists( other->m_glContext, m_glContext );
if( other != 0 )
wglShareLists( other->m_glContext, m_glContext );
default:
logb.lbStyle = BS_SOLID;
#ifdef __WXDEBUG__
default:
logb.lbStyle = BS_SOLID;
#ifdef __WXDEBUG__
- // this should be unnecessary (it's unused) but suppresses the Purigy
+ // this should be unnecessary (it's unused) but suppresses the Purify
// messages about uninitialized memory read
logb.lbHatch = 0;
#endif
// messages about uninitialized memory read
logb.lbHatch = 0;
#endif