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

Doc & Symantec C++ fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1325 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-01-07 08:43:47 +00:00
parent 06cfab1738
commit 2432b92dd7
97 changed files with 576 additions and 326 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/latex/wx/closeevt.tex
View File

@@ -17,7 +17,7 @@ functions that take a wxCloseEvent argument.
event applies to wxFrame and wxDialog classes.}
\twocolitem{{\bf EVT\_QUERY\_END\_SESSION(func)}}{Process a query end session event, supplying the member function.
This event applies to wxApp only.}
\twocolitem{{\bf EVT\__END\_SESSION(func)}}{Process an end session event, supplying the member function.
\twocolitem{{\bf EVT\_END\_SESSION(func)}}{Process an end session event, supplying the member function.
This event applies to wxApp only.}
\end{twocollist}%

40
docs/latex/wx/filetype.tex
View File

@@ -31,7 +31,7 @@ typically correspond to the extension ".txt", but may as well be associated with
\wxheading{Required headers}
#include <wx/mimetype.h>
<wx/mimetype.h>
\wxheading{Derived from}
@@ -64,10 +64,10 @@ function, for example:
\begin{verbatim}
// provide the message parameters for the MIME type manager
class MailMessageParamaters : public wxFileType::MessageParameters
class MailMessageParameters : public wxFileType::MessageParameters
{
public:
MailMessageParamaters(const wxString& filename,
MailMessageParameters(const wxString& filename,
const wxString& mimetype)
: wxFileType::MessageParameters(filename, mimetype)
{
@@ -85,7 +85,7 @@ public:
\end{verbatim}
Now you only need to create an object of this class and pass it to, for example,
\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
\rtfsp\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
\begin{verbatim}
wxString command;
@@ -99,7 +99,6 @@ else
{
// we don't know how to handle such files...
}
\end{verbatim}
{\bf Windows:} As only the file name is used by the program associated with the
@@ -107,25 +106,28 @@ given extension anyhow (but no other message parameters), there is no need to
ever derive from MessageParameters class for a Windows-only program.
\membersection{wxFileType::wxFileType}\label{wxfiletypewxfiletype}
\func{}{wxFileType}{\void}
The default constructor is private because you should never create objects of
this type: they are only returned by
\helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
this type: they are only returned by \helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
\membersection{wxFileType::\destruct{wxFileType}}\label{wxfiletypedtor}
\func{}{\destruct{wxFileType}{\void}
\func{}{\destruct{wxFileType}}{\void}
The destructor of this class is not virtual, so it should not be derived from.
\membersection{wxFileType::GetMimeType}\label{wxfiletypegetmimetype}
\func{bool}{GetMimeType}{\param{wxString *}{mimeType}}
\func{bool}{GetMimeType}{\param{wxString*}{ mimeType}}
If the function returns TRUE, the string pointed to by {\it mimeType} is filled
with full MIME type specification for this file type: for example, "text/plain".
\membersection{wxFileType::GetExtensions}\label{wxfiletypegetextensions}
\func{bool}{GetExtensions}{\param{wxArrayString \&}{extensions}}
\func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}}
If the function returns TRUE, the array {\it extensions} is filled
with all extensions associated with this file type: for example, it may
@@ -139,7 +141,8 @@ by \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension
function in the first place.
\membersection{wxFileType::GetIcon}\label{wxfiletypegeticon}
\func{bool}{GetIcon}{\param{wxIcon *}{icon}}
\func{bool}{GetIcon}{\param{wxIcon*}{ icon}}
If the function returns TRUE, the icon associated with this file type will be
created and assigned to the {\it icon} parameter.
@@ -147,14 +150,16 @@ created and assigned to the {\it icon} parameter.
{\bf Unix:} This function always returns FALSE under Unix.
\membersection{wxFileType::GetDescription}\label{wxfiletypegetdescription}
\func{bool}{GetDescription}{\param{wxString *}{desc}}
\func{bool}{GetDescription}{\param{wxString*}{ desc}}
If the function returns TRUE, the string pointed to by {\it desc} is filled
with a brief description for this file type: for example, "text document" for
the "text/plain" MIME type.
\membersection{wxFileType::GetOpenCommand}\label{wxfiletypegetopencommand}
\func{bool}{GetOpenCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
\func{bool}{GetOpenCommand}{\param{wxString*}{ command}, \param{MessageParameters\&}{ params}}
If the function returns TRUE, the string pointed to by {\it command} is filled
with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -162,7 +167,8 @@ order to open the file of the given type. The name of the file is
retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
\membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand}
\func{bool}{GetPrintCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
\func{bool}{GetPrintCommand}{\param{wxString*}{ command},\param{MessageParameters\&}{ params}}
If the function returns TRUE, the string pointed to by {\it command} is filled
with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -170,13 +176,15 @@ order to print the file of the given type. The name of the file is
retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
\membersection{wxFileType::ExpandCommand}\label{wxfiletypeexpandcommand}
\func{static wxString}{ExpandCommand}{\param{const wxString \&}{command},\param{MessageParameters \&}{params}}
\func{static wxString}{ExpandCommand}{\param{const wxString\&}{ command}, \param{MessageParameters\&}{ params}}
This function is primarly intended for GetOpenCommand and GetPrintCommand
usage but may be also used by the application directly if, for example, you want
to use some non default command to open the file.
The function replaces all occurences of
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{format specificator}{with}
@@ -184,6 +192,7 @@ The function replaces all occurences of
\twocolitem{\%t}{the MIME type}
\twocolitem{\%\{param\}}{the value of the parameter {\it param}}
\end{twocollist}
using the MessageParameters object you pass to it.
If there is no '\%s' in the command string (and the string is not empty), it is
@@ -192,3 +201,4 @@ as "< \%s" were appended to the string.
Unlike all other functions of this class, there is no error return for this
function.

2
docs/latex/wx/helpinst.tex
View File

@@ -19,7 +19,7 @@ appropriate class is aliased to the name wxHelpController for each platform.
There are currently the following help controller classes defined:
\begin{itemize}\itemsep=0
\begin{itemize}\itemsep=0pt
\item wxWinHelpController, for controlling Windows Help.
\item wxExtHelpController, for controlling external browsers under Unix.
The default browser is Netscape Navigator.

2
docs/latex/wx/image.tex
View File

@@ -419,8 +419,6 @@ Returns TRUE if the images were unequal, FALSE otherwise.
\section{\class{wxImageHandler}}\label{wximagehandler}
\overview{Overview}{wximageoverview}
This is the base class for implementing image file loading/saving, and image creation from data.
It is used within wxImage and is not normally seen by the application.

2
docs/latex/wx/menuitem.tex
View File

@@ -11,7 +11,7 @@ wxOwnerDrawn (Windows only)\\
\wxheading{See also}
\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}, \helpref{wxOwnerDrawn}{wxownerdrawn}
\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
\latexignore{\rtfignore{\wxheading{Members}}}

31
docs/latex/wx/mimetype.tex
View File

@@ -24,7 +24,7 @@ but it will support modifying it as well in the future versions.
\wxheading{Required headers}
#include <wx/mimetype.h>
<wx/mimetype.h>
\wxheading{Derived from}
@@ -46,18 +46,18 @@ program.
\membersection{Query database}
These functions are the heart of this class: they allow to find a
\helpref{file type}{wxfiletype} object from either file extension or MIME type.
These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object
from either file extension or MIME type.
If the function is successful, it returns a pointer to the wxFileType object
which {\bf must be deleted by the caller}, otherwise NULL will be returned.
which {\bf must} be deleted by the caller, otherwise NULL will be returned.
\helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\
\helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
\membersection{Initialization functions}
\membersection{Initialization functions}\label{wxmimetypesmanagerinit}
{\bf Unix:} These functions may be used to load additional (except for the
default ones which are loaded automatically) files containing MIME
{\bf Unix:} These functions may be used to load additional files (except for the
default ones which are loaded automatically) containing MIME
information in either mailcap(5) or mime.types(5) format.
\helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\
@@ -71,6 +71,7 @@ information in either mailcap(5) or mime.types(5) format.
}}
\membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
\func{}{wxMimeTypesManager}{\void}
Constructor puts the object in the "working" state, no additional initialization
@@ -78,34 +79,40 @@ are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load
additional mailcap/mime.types files.
\membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor}
\func{}{\destruct{wxMimeTypesManager}{\void}
\func{}{\destruct{wxMimeTypesManager}}{\void}
Destructor is not virtual, so this class should not be derived from.
\membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension}
\func{wxFileType *}{GetFileTypeFromExtension}{\param{const wxString \&}{extension}}
\func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}}
Gather information about the files with given extension and return the
corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension
is unknown.
\membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype}
\func{wxFileType *}{GetFileTypeFromMimeType}{\param{const wxString \&}{mimeType}}
\func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}}
Gather information about the files with given MIME type and return the
corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type
is unknown.
\membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap}
\func{\void}{ReadMailcap}{\param{const wxString \&}{filename}}
\func{void}{ReadMailcap}{\param{const wxString\&}{ filename}}
Load additional file containing information about MIME types and associated
information in mailcap format. See metamail(1) and mailcap(5) for more
information.
\membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes}
\func{\void}{ReadMimeTypes}{\param{const wxString \&}{filename}}
\func{void}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
Load additional file containing information about MIME types and associated
information in mime.types file format. See metamail(1) and mailcap(5) for more
information.

9
docs/latex/wx/mutexlck.tex
View File

@@ -13,24 +13,27 @@ None.
\wxheading{See also}
\helpref{wxMutex}{wxmutex},
\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
\helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
\func{}{wxMutexLocker}{\param{wxMutex *}{mutex}}
Constructs a wxMutexLocker object associated with mutex which must be non NULL
and locks it. Call \helpref{IsOk}{wxmutexisok} to check if the mutex was
and locks it. Call \helpref{IsLocked}{wxmutexlockerisok} to check if the mutex was
successfully locked.
\membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}
\func{}{\destruct{wxMutexLocker}}{\void}
Destuctor releases the mutex if it was successfully acquired in the ctor.
\membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}
\constfunc{bool}{IsOk}{\void}
Returns TRUE if mutex was acquired in the constructor, FALSE otherwise.

4
docs/latex/wx/noteevt.tex
View File

@@ -16,9 +16,9 @@ functions that take a wxNotebookEvent argument.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a
\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed. Processes a
wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.}
\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed.
\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed.
Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.}
\end{twocollist}%

3
docs/latex/wx/sashwin.tex
View File

@@ -182,9 +182,6 @@ Call this function to make a sash visible or invisible on a particular edge.
\helpref{wxSashWindow::GetSashVisible}{wxsashwindowgetsashvisible}
// Set whether there's a border in this position
inline void SetSashBorder(wxSashEdgePosition edge, bool border) { m_sashes[edge].m_border = border; }
\membersection{wxSashWindow::SetSashBorder}\label{wxsashwindowsetsashborder}
\func{void}{SetSashBorder}{\param{wxSashEdgePosition }{edge}, \param{bool}{ hasBorder}}

2
docs/latex/wx/tdnd.tex
View File

@@ -92,7 +92,7 @@ this, \helpref{GetFormatCount}{wxdroptargetgetformatcount} and \helpref{GetForma
used and if the format is
supported (i.e. is one of returned by GetFormat()),
then \helpref{OnDrop}{wxdroptargetondrop} is called.
Otherwise, \helpref{wxDragNone}{stdformat} is returned by DoDragDrop() and
Otherwise, wxDragNone is returned by DoDragDrop() and
nothing happens.
\item {\bf The end:} After processing the data, DoDragDrop() returns either

132
docs/msw/todo.txt
View File

@@ -5,73 +5,52 @@ Todo on wxWin 2.0, Windows platform
HIGH PRIORITY
-------------
Find/add wxThread sample - Arthur T-D?
Implement wxDC floating point transformations.
Add wxDC::DeviceToLogical -> wxPoint etc (convenience accessors).
Revamp Dialog Editor for new controls and properties (e.g.
window id).
Add further controls and properties to Dialog Editor.
Update manual.
wxApp changes DONE
wxMenu changes DONE
wxModule DONE
wxRegion DONE
wxFile DONE
wxTempFile
wxMask DONE
wxDC:Blit DONE
wxTaskBarIcon DONE
wxMsgCatalog etc.
wxLog
wxConfig DONE
wxRegKey
wxTabCtrl DONE
wxNotebook DONE (some more explanation required)
wxWave DONE
wxJoystick DONE
wxStatusBar95 and wxFrame status bar functions
wxListBox changes (for ownerdraw functionality)
wxThread DONE (except for topic overview)
wxHelpController classes DONE (except for Unix ones)
wxString PARTLY DONE
Drag and drop (change API if required, e.g. const).
wxCheckListBox DONE
wxAcceleratorTable DONE
wxBaseArray, other arrays
(wxOwnerDrawn)
Document the include file for each class
Macros, e.g. wxASSERT
Stream classes
wxSocket topic overview
Functions
Write tutorial.
Makefiles and/or IDE files for other compilers: Symantec C++,
Salford C++. IDE files for BC++.
A wxDC function (or two) for drawing 3D edges.
Check TODO entries in source and manual.
Makefiles for other compilers. Generic makefiles?
Rewrite makefiles to maintain simultaneous debug/release
objects.
Add centring, right justify styles to wxStaticText.
Extend wxSystemSettings to get symbols for current nationality,
e.g. ',' instead of '.' for decimal points.
LOW PRIORITY (MEDIUM TERM)
--------------------------
Convert remaining utilities e.g. wxGraphLayout.
More wxSystemSettings (see comment in settings.cpp).
Convert remaining utilities e.g. (GLCanvas; wxGraphLayout) and samples
Check TODO entries.
Synchronize drawing functions on all platforms, using Chris's
code to test them.
Shell function to invoke a document with open, print, whatever...
Make use of Vadim's gettext implementation throughout wxWin code.
Document it.
Write tutorial.
Retain callback functions; have semi-compatible callback function prototypes
for all controls, at least in WXWIN_COMPATIBLE mode, but
retain (Set)Callback for all compilations. This is following a
panicky response to losing callbacks.
Add wxDC::DeviceToLogical -> wxPoint etc (convenience accessors).
Merge dib.cpp, dibutils.cpp (see also some DIB code in bitmap.cpp).
Generic makefiles? Rewrite makefiles to maintain simultaneous debug/release
objects.
Add a wxTabCtrl sample.
@@ -81,16 +60,7 @@ printer characteristics) and more reliable printing framework.
Add GetIcon, GetBitmap to wxImageList. Perhaps store bitmaps
in image list so we can get them later.
Add centring, right justify styles to wxStaticText.
Synchronize drawing functions on all platforms, using Chris's
code to test them.
Extend wxSystemSettings to get symbols for current nationality,
e.g. ',' instead of '.' for decimal points.
LOW PRIORITY
------------
Merge dib.cpp, dibutils.cpp (see also some DIB code in bitmap.cpp).
Debug PNG support in wxBitmap (no 4-bit support), and possibly add a convertor from PNG
to HICON. We could perhaps also support inclusion of PNGs into
@@ -100,46 +70,25 @@ Fonts: ability to enumerate them.
Angled text.
Eliminate Set/GetDefaultBackgroundColour? Just take background
colour for child control instead.
Think about reimplementing wxBitmapButton, wxStaticBitmap using
BS_BITMAP, SS_BITMAP - but this may not allow wxBitmap
argument, so instead just allow controls loaded from native
resource to deal with this style and call default processing.
Better clipboard support.
Better clipboard support (as per Robert's class).
wxWizard class?
Doc/view - have some standard views/docs e.g. wxTextView.
wxClassWizard for generating files, chunks of code.
Miscellaneous file/system function wrappers.
wxImage or replacement; further wxBitmap/wxIcon etc. functions
(load animated icos).
Integrate existing multimedia classes.
Rich text class?
Look at WinCE stuff incl. database classes.
Improve conversion guide, compatibility classes, tools?
Bug database.
ActiveX support?
OpenGL integration.
OpenGL integration: check that wxGLCanvas works cross-platform.
Menu bitmaps - document Vadim's enhancements.
Enhance Tex2RTF to generate Microsoft HTML help, perhaps Netscape
HTML help also.
wxCreateDynamicObject is apparently slow: ~ 2000 calls to strcmp. Need to
use some kind of hash table scheme.
@@ -149,8 +98,6 @@ to wxFrame to mirror the X situation (multiple displays).
Write translator between old and new .wxr formats (including
substituting static text for obsolete labels).
Improve and expand wxSizer classes.
Write more validators. Also, how do they work if loading the
dialog from a .wxr? Could call SetValidator from within
InitDialog for all controls, then call TransferDataToWindow.
@@ -159,6 +106,30 @@ Classes for file/OS utility functions.
Add support for more static controls e.g. wxStaticLine.
Perhaps rewrite wxFile to use FILE* descriptors, so Eof and Flush
can work.
Find out how to set wxFileDialog position.
Maybe bundle Andrew Tucker's DBWIN32 with wxWindows (it's only
26KB), for viewing debug messages without a debugger.
Implement wxDC floating point transformations.
A wxDC function (or two) for drawing 3D edges?
LOW PRIORITY (LONG TERM)
------------------------
Improve and expand wxSizer classes.
ActiveX support
Look at porting to WinCE
Enhance Tex2RTF to generate Microsoft HTML help, perhaps Netscape
HTML help also.
GDI objects could be optimised further in constructors by
searching for a matching, pre-existing object, and assigning from
that, thus sharing the internal handle. A problem with this
@@ -181,10 +152,9 @@ needed to ensure that the operation was maximally efficient
(creating a new object rather than searching may or may not be
more efficient).
Perhaps rewrite wxFile to use FILE* descriptors, so Eof and Flush
can work.
Integrate Guilhem's multimedia classes: documentation, makefiles,
different platforms.
Rich text class.
Find out how to set wxFileSelector position.
Maybe bundle Andrew Tucker's DBWIN32 with wxWindows (it's only
26KB), for viewing debug messages without a debugger.