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

Doc tweaks

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30578 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2004-11-16 20:48:11 +00:00
parent fe4fcb5f4f
commit f6bb64a625
6 changed files with 48 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -547,7 +547,7 @@ development can be done. The program can be found in {\tt utils/configtool}.
This is the sizer-aware resource system, and uses
XML-based resource specifications that can be generated by tools
such as \urlref{wxDesigner}{http://www.roebling.de} and XRC's own wxrcedit.
You can find this in {\tt contrib/src/xrc}, {\tt contrib/include/wx/xrc}, {\tt contrib/samples/xrc}, and {\tt contrib/utils/wxrcedit}.
You can find this in {\tt src/xrc}, {\tt include/wx/xrc}, {\tt samples/xrc}, and {\tt utils/wxrcedit}.
For more information, see the \helpref{XML-based resource system overview}{xrcoverview}.
\item[{\bf Object Graphics Library}]
OGL defines an API for applications that need to display objects connected by lines.

20
docs/latex/wx/dataobj.tex
View File

@@ -13,10 +13,10 @@
A wxDataObject represents data that can be copied to or from the clipboard, or
dragged and dropped. The important thing about wxDataObject is that this is a
'smart' piece of data unlike usual 'dumb' data containers such as memory
'smart' piece of data unlike 'dumb' data containers such as memory
buffers or files. Being 'smart' here means that the data object itself should
know what data formats it supports and how to render itself in each of
supported formats.
its supported formats.
A supported format, incidentally, is exactly the format in which the data can
be requested from a data object or from which the data object may be set. In
@@ -33,7 +33,7 @@ enum Direction
};
\end{verbatim}
which allows to distinguish between them. See
which distinguishes between them. See
\helpref{wxDataFormat}{wxdataformat} documentation for more about formats.
Not surprisingly, being 'smart' comes at a price of added complexity. This is
@@ -47,8 +47,8 @@ which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple}
\helpref{wxDataObjectSimple}{wxdataobjectsimple} is
the simplest wxDataObject possible and only holds data in a single format (such
as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is
the simplest way to implement wxDataObject which does support multiple formats
because it achievs this by simply holding several wxDataObjectSimple objects.
the simplest way to implement a wxDataObject which that does support multiple formats
because it achieves this by simply holding several wxDataObjectSimple objects.
So, you have several solutions when you need a wxDataObject class (and you need
one as soon as you want to transfer data via the clipboard or drag and drop):
@@ -65,7 +65,7 @@ in your program (or between different copies of it).}
solution which allows you to support any number of formats (either
standard or custom if you combine it with the previous solution).}
\twocolitem{{\bf 4. Use wxDataObject directly}}{This is the solution for
maximal flexibility and efficiency, but it is also is the most difficult to
maximal flexibility and efficiency, but it is also the most difficult to
implement.}
\end{twocollist}
@@ -78,8 +78,8 @@ the clipboard and even today's computers are in trouble. For this case, you
will have to derive from wxDataObject directly and make it enumerate its
formats and provide the data in the requested format on demand.
Note that neither the GTK data transfer mechanisms for the clipboard and
drag and drop, nor the OLE data transfer copy any data until another application
Note that neither the GTK+ data transfer mechanisms for clipboard and
drag and drop, nor OLE data transfer, copy any data until another application
actually requests the data. This is in contrast to the 'feel' offered to the
user of a program who would normally think that the data resides in the
clipboard after having pressed 'Copy' - in reality it is only declared to be
@@ -93,9 +93,9 @@ change.
You may also derive your own data object classes from
\helpref{wxCustomDataObject}{wxcustomdataobject} for user-defined types. The
format of user-defined data is given as mime-type string literal, such as
format of user-defined data is given as a mime-type string literal, such as
"application/word" or "image/png". These strings are used as they are under
Unix (so far only GTK) to identify a format and are translated into their
Unix (so far only GTK+) to identify a format and are translated into their
Windows equivalent under Win32 (using the OLE IDataObject for data exchange to
and from the clipboard and for drag and drop). Note that the format string
translation under Windows is not yet finished.

29
docs/latex/wx/grid.tex
View File

@@ -550,12 +550,6 @@ Get the minimal width of the given column/row.
Returns the width of the specified column.
\membersection{wxGrid::GetColWidth}\label{wxgridgetcolwidth}
\constfunc{int}{GetColWidth}{\param{int }{col}}
Get the col/row coords
\membersection{wxGrid::GetDefaultCellAlignment}\label{wxgridgetdefaultcellalignment}
\func{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
@@ -707,21 +701,6 @@ Returns the total number of grid rows (actually the number of rows in the underl
\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
\membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight}
\constfunc{int}{GetRowHeight}{\param{int }{row}}
This function must be public for compatibility.
\membersection{wxGrid::GetRowTop}\label{wxgridgetrowtop}
\constfunc{int}{GetRowTop}{\param{int }{row}}
\membersection{wxGrid::GetRowBottom}\label{wxgridgetrowbottom}
\constfunc{int}{GetRowBottom}{\param{int }{row}}
\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
\func{int}{GetRowMinimalAcceptableHeight}{}
@@ -1305,6 +1284,12 @@ Sets the default background colour for grid cells.
Sets the default font to be used for grid cell text.
\membersection{wxGrid::SetDefaultCellTextColour}\label{wxgridsetdefaultcelltextcolour}
\func{void}{SetDefaultCellTextColour}{\param{const wxColour\&}{ colour}}
Sets the current default colour for grid cell text.
\membersection{wxGrid::SetDefaultEditor}\label{wxgridsetdefaulteditor}
\func{void}{SetDefaultEditor}{\param{wxGridCellEditor* }{editor}}
@@ -1499,7 +1484,7 @@ Set the selection behaviour of the grid.
\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
\docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
\docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.}
\membersection{wxGrid::SetTable}\label{wxgridsettable}

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

@@ -88,7 +88,7 @@ Returns the currently focused item or $-1$ if none.
\constfunc{long}{GetNextSelected}{\param{long }{item}}
Used together with \helpref{GetFirstSelected}{wxlistviewgetfirstselected} to
iterate oevr all selected items in the control.
iterate over all selected items in the control.
\wxheading{Return value}

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

@@ -120,7 +120,7 @@ contain a function called {\it InitXmlResource} (unless you override this with
a command line switch). Use it to load the resource:
\begin{verbatim}
extern void InitXMLResource(); // defined in generated file
extern void InitXmlResource(); // defined in generated file
...
wxXmlResource::Get()->InitAllHandlers();
InitXmlResource();

28
docs/latex/wx/window.tex
View File

@@ -1025,6 +1025,19 @@ the button text. This function can be useful for meta-programs (such as testing
tools or special-needs access programs) which need to identify windows
by name.
\membersection{wxWindow::GetMaxSize}\label{wxwindowgetmaxsize}
\constfunc{wxSize}{GetMaxSize}{\void}
Returns the maximum size of the window, an indication to the sizer layout mechanism
that this is the maximum possible size.
\membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
\constfunc{wxSize}{GetMinSize}{\void}
Returns the minimum size of the window, an indication to the sizer layout mechanism
that this is the minimum required size.
\membersection{wxWindow::GetName}\label{wxwindowgetname}
@@ -2572,6 +2585,21 @@ the constraints automatically in OnSize; otherwise, you must override OnSize and
explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
sizer will have effect.
\membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize}
\func{void}{SetMaxSize}{\param{const wxSize\& }{size}}
Sets the maximum size of the window, to indicate to the sizer layout mechanism
that this is the maximum possible size.
\membersection{wxWindow::SetMinSize}\label{wxwindowsetminsize}
\func{void}{SetMinSize}{\param{const wxSize\& }{size}}
Sets the minimum size of the window, to indicate to the sizer layout mechanism
that this is the minimum required size. You may need to call this
if you change the window size after construction and before adding
to its parent sizer.
\membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour}