Removed old wxGLCanvas stuff; moved wxTreeLayout to wxWindows; corrected some doc errors
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6330 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -125,7 +125,7 @@ WX_DEFINE_SORTED_ARRAY(MyFile *, ArrayOfFiles);
|
||||
|
||||
\helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist}
|
||||
|
||||
\wxheading{Required headers:}
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/dynarray.h> for wxArray and wxSortedArray and additionally <wx/arrimpl.cpp>
|
||||
for wxObjArray.
|
||||
|
@@ -284,6 +284,7 @@
|
||||
\input toolbar.tex
|
||||
\input treectrl.tex
|
||||
\input treeevt.tex
|
||||
\input treelay.tex
|
||||
\input upduievt.tex
|
||||
\input url.tex
|
||||
\input validatr.tex
|
||||
|
@@ -3,10 +3,8 @@
|
||||
% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndaiff.h at 26/Feb/00 14:52:29
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxSoundAiff}}\label{wxsoundaiff}
|
||||
|
||||
|
||||
AIFF codec
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
@@ -16,9 +16,9 @@ Base class for sound streams
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Include file}
|
||||
\wxheading{Include files}
|
||||
|
||||
wx/mmedia/sndbase.h
|
||||
<wx/mmedia/sndbase.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
@@ -56,6 +56,7 @@ may happen when you call wxSoundRouterStream::SetSoundFormat().}
|
||||
|
||||
When a sound event is generated, it may either call the internal sound event
|
||||
processor (which can be inherited) or call a C function. Its definition is:
|
||||
|
||||
\begin{verbatim}
|
||||
typedef void (*wxSoundCallback)(wxSoundStream *stream, int evt,
|
||||
void *cdata);
|
||||
@@ -63,13 +64,13 @@ processor (which can be inherited) or call a C function. Its definition is:
|
||||
|
||||
The {\bf stream} parameter represents the current wxSoundStream.
|
||||
|
||||
The {\bf evt} parameter represents the sound event which is the cause of the calling. (See \helpref{wxSound events}{wxsoundstreamevents})
|
||||
The {\bf evt} parameter represents the sound event which is the cause of the calling. (See \helpref{wxSound events}{wxsoundstreamevents}).
|
||||
|
||||
The {\bf cdata} parameter represents the user callback data which were specified
|
||||
when the user called \helpref{wxSoundStream::Register}{wxsoundstreamregister}.
|
||||
|
||||
{\bf\it Note:} There is two other ways to catch sound events: you can inherit the
|
||||
sound stream and redefine \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}, or you can reroute the events to another sound stream using \helpref{wxSoundStream::SetEventHandler}{wxsoundstreameventhandler}
|
||||
{\it Note:} There are two other ways to catch sound events: you can inherit the
|
||||
sound stream and redefine \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}, or you can reroute the events to another sound stream using \helpref{wxSoundStream::SetEventHandler}{wxsoundstreameventhandler}.
|
||||
|
||||
%%
|
||||
%% wxSoundStream streaming mode
|
||||
@@ -78,18 +79,18 @@ sound stream and redefine \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamons
|
||||
\wxheading{wxSound streaming mode}
|
||||
|
||||
The wxSoundStream object can work in three different modes. These modes are specified
|
||||
at the call to \helpref{wxSoundStream::StartProduction}{wxsoundstreamstartproduction}
|
||||
and cannot be changed until you call
|
||||
at the call to \helpref{wxSoundStream::StartProduction}{wxsoundstreamstartproduction}
|
||||
and cannot be changed until you call
|
||||
\helpref{wxSoundStream::StopProduction}{wxsoundstreamstopproduction}.
|
||||
|
||||
The {\bf wxSOUND\_INPUT} mode is the recording mode. It generates {\bf wxSOUND\_INPUT}
|
||||
The {\bf wxSOUND\_INPUT} mode is the recording mode. It generates {\bf wxSOUND\_INPUT}
|
||||
events and you cannot use wxSoundStream::Write().
|
||||
|
||||
The {\bf wxSOUND\_OUTPUT} mode is the playing mode. It generates {\bf wxSOUND\_OUTPUT}
|
||||
The {\bf wxSOUND\_OUTPUT} mode is the playing mode. It generates {\bf wxSOUND\_OUTPUT}
|
||||
events and you cannot use wxSoundStream::Read().
|
||||
|
||||
The {\bf wxSOUND\_DUPLEX} mode activates the full duplex mode. The full duplex needs
|
||||
you make synchronous call to \helpref{wxSoundStream::Read}{wxsoundstreamread} and
|
||||
The {\bf wxSOUND\_DUPLEX} mode activates the full duplex mode. The full duplex requires
|
||||
you to make synchronous call to \helpref{wxSoundStream::Read}{wxsoundstreamread} and
|
||||
\helpref{wxSoundStream::Write}{wxsoundstreamwrite}. This means that you must be
|
||||
careful with realtime problems. Each time you call Read you must call Write.
|
||||
|
||||
@@ -136,30 +137,29 @@ any temporary buffer.
|
||||
|
||||
\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
|
||||
|
||||
Reads \it{len} bytes from the sound stream. This call may block the user so
|
||||
Reads {\it len} bytes from the sound stream. This call may block the user so
|
||||
use it carefully when you need to intensively refresh the GUI. You may be
|
||||
interested by sound events: see
|
||||
\helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}.
|
||||
interested by sound events: see \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}.
|
||||
|
||||
It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the
|
||||
sound event system.
|
||||
|
||||
\wxheading{Note on \it{len}}
|
||||
\wxheading{Parameters}
|
||||
|
||||
\it{len} is expressed in bytes. If you need to do conversions between bytes
|
||||
\docparam{len}{{\it len} is expressed in bytes. If you need to do conversions between bytes
|
||||
and seconds use wxSoundFormat.
|
||||
See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.
|
||||
See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.}
|
||||
|
||||
\wxheading{Note on data}
|
||||
|
||||
Data in \it{buffer} are coded using the sound format attached to this sound
|
||||
\docparam{data}{Data in \it{buffer} are coded using the sound format attached to this sound
|
||||
stream. The format is specified with
|
||||
\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}
|
||||
\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.}
|
||||
|
||||
%%
|
||||
%% Write
|
||||
%%
|
||||
|
||||
\membersection{wxSoundStream::Write}\label{wxsoundstreamwrite}
|
||||
|
||||
\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
|
||||
|
||||
Writes \it{len} bytes to the sound stream. This call may block the user so
|
||||
@@ -169,17 +169,15 @@ use it carefully. You may be interested by sound events: see
|
||||
It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the
|
||||
sound event system.
|
||||
|
||||
\wxheading{Note on \it{len}}
|
||||
\wxheading{Parameters}
|
||||
|
||||
\it{len} is expressed in bytes. If you need to do conversions between bytes
|
||||
\docparam{len}{This is expressed in bytes. If you need to do conversions between bytes
|
||||
and seconds use wxSoundFormat.
|
||||
See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.
|
||||
See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.}
|
||||
|
||||
\wxheading{Note on data}
|
||||
|
||||
Data in \it{buffer} are coded using the sound format attached to this sound
|
||||
\docparam{buffer}{Data in \it{buffer} are coded using the sound format attached to this sound
|
||||
stream. The format is specified with
|
||||
\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}
|
||||
\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.}
|
||||
|
||||
%%
|
||||
%% GetBestSize
|
||||
@@ -199,6 +197,7 @@ will not block for this buffer size.
|
||||
%%
|
||||
|
||||
\membersection{wxSoundStream::SetSoundFormat}\label{wxsoundstreamsetsoundformat}
|
||||
|
||||
\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
|
||||
|
||||
SetSoundFormat is one of the key function of the wxSoundStream object. It specifies
|
||||
@@ -206,7 +205,7 @@ the sound format the user needs. SetSoundFormat tries to apply the format to the
|
||||
current sound stream (it can be a sound file or a sound driver).
|
||||
Then, either it manages to apply it and it returns {\bf TRUE}, or it could not and
|
||||
it returns {\bf FALSE}. In this case, you must check the error with
|
||||
\helpref{wxSoundStream::GetError}{wxsoundstreamgeterror}. See
|
||||
\helpref{wxSoundStream::GetError}{wxsoundstreamgeterror}. See
|
||||
\helpref{wxSoundStream errors section}{wxsoundstreamerrors} for more details.
|
||||
|
||||
\wxheading{Remark}
|
||||
@@ -227,6 +226,7 @@ the stream itself.
|
||||
%% SetCallback
|
||||
%%
|
||||
\membersection{wxSoundStream::SetCallback}\label{wxsoundstreamregister}
|
||||
|
||||
\func{void}{Register}{\param{int }{evt}, \param{wxSoundCallback }{cbk}, \param{void* }{cdata}}
|
||||
|
||||
It installs a C callback for wxSoundStream events. The C callbacks are still useful
|
||||
@@ -249,29 +249,29 @@ recording or playing or the two at the same time.
|
||||
|
||||
Stops the async notifier.
|
||||
|
||||
|
||||
\membersection{wxSoundStream::SetEventHandler}\label{wxsoundstreamseteventhandler}
|
||||
|
||||
\func{void}{SetEventHandler}{\param{wxSoundStream* }{handler}}
|
||||
|
||||
Sets the event handler: if it is non-null, all events are routed to it.
|
||||
|
||||
|
||||
\membersection{wxSoundStream::GetError}\label{wxsoundstreamgeterror}
|
||||
|
||||
\constfunc{wxSoundError}{GetError}{\void}
|
||||
|
||||
|
||||
\membersection{wxSoundStream::GetLastAccess}\label{wxsoundstreamgetlastaccess}
|
||||
|
||||
\constfunc{wxUint32}{GetLastAccess}{\void}
|
||||
|
||||
|
||||
\membersection{wxSoundStream::QueueFilled}\label{wxsoundstreamqueuefilled}
|
||||
|
||||
\constfunc{bool}{QueueFilled}{\void}
|
||||
|
||||
This is only useful for device (I think).
|
||||
|
||||
|
||||
\membersection{wxSoundStream::OnSoundEvent}\label{wxsoundstreamonsoundevent}
|
||||
|
||||
\func{void}{OnSoundEvent}{\param{int }{evt}}
|
||||
|
||||
Handles event
|
||||
Handles event.
|
||||
|
||||
|
@@ -3,7 +3,6 @@
|
||||
% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndcodec.h at 26/Feb/00 14:26:29
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxSoundStreamCodec}}\label{wxsoundstreamcodec}
|
||||
|
||||
\wxheading{Derived from}
|
||||
@@ -14,7 +13,6 @@
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxSoundStreamCodec::wxSoundStreamCodec}\label{wxsoundstreamcodecwxsoundstreamcodec}
|
||||
|
||||
\func{}{wxSoundStreamCodec}{\param{wxSoundStream\& }{snd\_io}}
|
||||
|
@@ -3,10 +3,8 @@
|
||||
% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndesd.h at 26/Feb/00 14:26:56
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxSoundStreamESD}}\label{wxsoundstreamesd}
|
||||
|
||||
|
||||
ESD output class
|
||||
|
||||
\wxheading{Derived from}
|
||||
@@ -20,7 +18,7 @@ ESD output class
|
||||
|
||||
\membersection{wxSoundStreamESD::wxSoundStreamESD}\label{wxsoundstreamesdwxsoundstreamesd}
|
||||
|
||||
\func{}{wxSoundStreamESD}{\param{const wxString\& }{hostname = \_T("localhost")}}
|
||||
\func{}{wxSoundStreamESD}{\param{const wxString\& }{hostname = "localhost"}}
|
||||
|
||||
|
||||
\membersection{wxSoundStreamESD::\destruct{wxSoundStreamESD}}\label{wxsoundstreamesddtor}
|
||||
|
@@ -26,9 +26,10 @@ typedef enum {
|
||||
{\small \begin{verbatim}
|
||||
typedef struct g72x\_state g72state
|
||||
\end{verbatim}}
|
||||
This fixes a bug in Mingw95
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
This fixes a bug in Mingw95
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxSoundFormatG72X::wxSoundFormatG72X}\label{wxsoundformatg72xwxsoundformatg72x}
|
||||
|
||||
@@ -80,7 +81,7 @@ This fixes a bug in Mingw95
|
||||
\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
|
||||
|
||||
|
||||
\membersection{wxSoundFormatG72X::operator!=}\label{wxsoundformatg72xoperator!=}
|
||||
\membersection{wxSoundFormatG72X::operator!=}\label{wxsoundformatg72xoperatorneq}
|
||||
|
||||
\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}
|
||||
|
||||
|
@@ -98,7 +98,7 @@ PCM specification class
|
||||
\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
|
||||
|
||||
|
||||
\membersection{wxSoundFormatPcm::operator!}\label{wxsoundformatpcmoperator!}
|
||||
\membersection{wxSoundFormatPcm::operator!}\label{wxsoundformatpcmoperatornot}
|
||||
|
||||
\constfunc{bool}{operator!}{\param{const wxSoundFormatBase\& }{frmt2}}
|
||||
|
||||
|
@@ -64,6 +64,6 @@ It clones the current format.
|
||||
\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
|
||||
|
||||
|
||||
\membersection{wxSoundFormatBase::operator!=}\label{wxsoundformatbaseoperator!=}
|
||||
\membersection{wxSoundFormatBase::operator!=}\label{wxsoundformatbaseoperatorneq}
|
||||
|
||||
\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}
|
||||
\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}
|
||||
|
@@ -68,7 +68,7 @@ ULAW format
|
||||
\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
|
||||
|
||||
|
||||
\membersection{wxSoundFormatUlaw::operator!=}\label{wxsoundformatulawoperator!=}
|
||||
\membersection{wxSoundFormatUlaw::operator!=}\label{wxsoundformatulawoperatorneq}
|
||||
|
||||
\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}
|
||||
|
||||
|
327
docs/latex/wx/treelay.tex
Normal file
327
docs/latex/wx/treelay.tex
Normal file
@@ -0,0 +1,327 @@
|
||||
\section{\class{wxTreeLayout}}\label{wxtreelayout}
|
||||
|
||||
wxTreeLayout provides layout of simple trees with one root node, drawn left-to-right,
|
||||
with user-defined spacing between nodes.
|
||||
|
||||
wxTreeLayout is an abstract class that must be subclassed. The programmer
|
||||
defines various member functions which will access whatever data structures
|
||||
are appropriate for the application, and wxTreeLayout uses these when laying
|
||||
out the tree.
|
||||
|
||||
Nodes are identified by long integer identifiers. The derived class
|
||||
communicates the actual tree structure to wxTreeLayout by defining \helpref{wxTreeLayout::GetChildren}{wxtreelayoutgetchildren}\rtfsp
|
||||
and \helpref{wxTreeLayout::GetNodeParent}{wxtreelayoutgetnodeparent} functions.
|
||||
|
||||
The application should call \helpref{wxTreeLayout::DoLayout}{wxtreelayoutdolayout} to do the tree
|
||||
layout. Depending on how the derived class has been defined, either
|
||||
\rtfsp\helprefn{wxTreeLayout::Draw}{wxtreelayoutdraw} must be called (for example by the OnPaint member
|
||||
of a wxScrolledWindow) or the application-defined drawing code should be called
|
||||
as normal.
|
||||
|
||||
For example, if you have an image drawing system already defined, you
|
||||
may want wxTreeLayout to position existing node images in that system. So you
|
||||
just need a way for wxTreeLayout to set the node image positions according to
|
||||
the layout algorithm, and the rest will be done by your own image drawing
|
||||
system.
|
||||
|
||||
The algorithm is due to Gabriel Robins \cite{robins87}, a linear-time
|
||||
algorithm originally implemented in LISP for AI applications.
|
||||
|
||||
The original algorithm has been modified so that both X and Y planes
|
||||
are calculated simultaneously, increasing efficiency slightly. The basic
|
||||
code is only a page or so long.
|
||||
|
||||
\helponly{Below is the example tree generated by the program test.cc.
|
||||
|
||||
\begin{figure}
|
||||
$$\image{11cm;0cm}{treetst.ps}$$
|
||||
\caption{Example tree}\label{exampletree}
|
||||
\end{figure}
|
||||
}
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
wxObject
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxLayoutTreeStored}{wxlayouttreestored}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxTreeLayout::wxTreeLayout}
|
||||
|
||||
\func{}{wxTreeLayout}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxTreeLayout::ActivateNode}\label{wxtreelayoutactivatenode}
|
||||
|
||||
\func{void}{ActivateNode}{\param{long}{ id}, \param{bool }{active}}
|
||||
|
||||
Define this so wxTreeLayout can turn nodes on and off for drawing purposes
|
||||
(not all nodes may be connected in the tree). See also \helprefn{NodeActive}{nodeactive}.
|
||||
|
||||
\membersection{wxTreeLayout::CalcLayout}
|
||||
|
||||
\func{void}{CalcLayout}{\param{long}{ id}, \param{int}{ level}}
|
||||
|
||||
Private function for laying out a branch.
|
||||
|
||||
\membersection{wxTreeLayout::DoLayout}\label{wxtreelayoutdolayout}
|
||||
|
||||
\func{void}{DoLayout}{\param{wxDC\&}{ dc}, \param{long}{ topNode = -1}}
|
||||
|
||||
Calculates the layout for the tree, optionally specifying the top node.
|
||||
|
||||
\membersection{wxTreeLayout::Draw}\label{wxtreelayoutdraw}
|
||||
|
||||
\func{void}{Draw}{\param{wxDC\&}{ dc}}
|
||||
|
||||
Call this to let wxTreeLayout draw the tree itself, once the layout has been
|
||||
calculated with \helprefn{DoLayout}{dolayout}.
|
||||
|
||||
\membersection{wxTreeLayout::DrawBranch}
|
||||
|
||||
\func{void}{DrawBranch}{\param{long}{ from}, \param{long}{ to}, \param{wxDC\&}{ dc}}
|
||||
|
||||
Defined by wxTreeLayout to draw an arc between two nodes.
|
||||
|
||||
\membersection{wxTreeLayout::DrawBranches}
|
||||
|
||||
\func{void}{DrawBranches}{\param{wxDC\&}{ dc}}
|
||||
|
||||
Defined by wxTreeLayout to draw the arcs between nodes.
|
||||
|
||||
\membersection{wxTreeLayout::DrawNode}
|
||||
|
||||
\func{void}{DrawNode}{\param{long}{ id}, \param{wxDC\&}{ dc}}
|
||||
|
||||
Defined by wxTreeLayout to draw a node.
|
||||
|
||||
\membersection{wxTreeLayout::DrawNodes}
|
||||
|
||||
\func{void}{DrawNodes}{\param{wxDC\&}{ dc}}
|
||||
|
||||
Defined by wxTreeLayout to draw the nodes.
|
||||
|
||||
\membersection{wxTreeLayout::GetChildren}\label{wxtreelayoutgetchildren}
|
||||
|
||||
\func{void}{GetChildren}{\param{long}{ id}, \param{wxList \&}{list}}
|
||||
|
||||
Must be defined to return the children of node {\it id} in the given list
|
||||
of integers.
|
||||
|
||||
\membersection{wxTreeLayout::GetNextNode}\label{wxtreelayoutgetnextnode}
|
||||
|
||||
\func{long}{GetNextNode}{\param{long}{ id}}
|
||||
|
||||
Must be defined to return the next node after {\it id}, so that wxTreeLayout can
|
||||
iterate through all relevant nodes. The ordering is not important.
|
||||
The function should return -1 if there are no more nodes.
|
||||
|
||||
\membersection{wxTreeLayout::GetNodeName}
|
||||
|
||||
\constfunc{wxString}{GetNodeName}{\param{long}{ id}}
|
||||
|
||||
May optionally be defined to get a node's name (for example if leaving
|
||||
the drawing to wxTreeLayout).
|
||||
|
||||
\membersection{wxTreeLayout::GetNodeSize}
|
||||
|
||||
\constfunc{void}{GetNodeSize}{\param{long}{ id}, \param{long*}{ x}, \param{long*}{ y}}
|
||||
|
||||
Can be defined to indicate a node's size, or left to wxTreeLayout to use the
|
||||
name as an indication of size.
|
||||
|
||||
\membersection{wxTreeLayout::GetNodeParent}\label{wxtreelayoutgetnodeparent}
|
||||
|
||||
\constfunc{long}{GetNodeParent}{\param{long}{ id}}
|
||||
|
||||
Must be defined to return the parent node of {\it id}.
|
||||
The function should return -1 if there is no parent.
|
||||
|
||||
\membersection{wxTreeLayout::GetNodeX}
|
||||
|
||||
\constfunc{long}{GetNodeX}{\param{long}{ id}}
|
||||
|
||||
Must be defined to return the current X position of the node. Note that
|
||||
coordinates are assumed to be at the top-left of the node so some conversion
|
||||
may be necessary for your application.
|
||||
|
||||
\membersection{wxTreeLayout::GetNodeY}
|
||||
|
||||
\constfunc{long}{GetNodeY}{\param{long}{ id}}
|
||||
|
||||
Must be defined to return the current Y position of the node. Note that
|
||||
coordinates are assumed to be at the top-left of the node so some conversion
|
||||
may be necessary for your application.
|
||||
|
||||
\membersection{wxTreeLayout::GetLeftMargin}
|
||||
|
||||
\constfunc{long}{GetLeftMargin}{\void}
|
||||
|
||||
Gets the left margin set with \helprefn{SetMargins}{setmargins}.
|
||||
|
||||
\membersection{wxTreeLayout::GetOrientation}
|
||||
|
||||
\constfunc{bool}{GetOrientation}{\void}
|
||||
|
||||
Gets the orientation: TRUE means top-to-bottom, FALSE means left-to-right (the default).
|
||||
|
||||
\membersection{wxTreeLayout::GetTopMargin}
|
||||
|
||||
\constfunc{long}{GetTopMargin}{\void}
|
||||
|
||||
Gets the top margin set with \helprefn{SetMargins}{setmargins}.
|
||||
|
||||
\membersection{wxTreeLayout::GetTopNode}
|
||||
|
||||
\constfunc{long}{GetTopNode}{\void}
|
||||
|
||||
wxTreeLayout calls this to get the top of the tree. Don't redefine this; call
|
||||
\rtfsp\helprefn{SetTopNode}{settopnode} instead before calling \helprefn{DoLayout}{dolayout}.
|
||||
|
||||
\membersection{wxTreeLayout::GetXSpacing}
|
||||
|
||||
\constfunc{long}{GetXSpacing}{\void}
|
||||
|
||||
Gets the horizontal spacing between nodes.
|
||||
|
||||
\membersection{wxTreeLayout::GetYSpacing}
|
||||
|
||||
\constfunc{long}{GetYSpacing}{\void}
|
||||
|
||||
Gets the vertical spacing between nodes.
|
||||
|
||||
\membersection{wxTreeLayout::Initialize}
|
||||
|
||||
\func{void}{Initialize}{\void}
|
||||
|
||||
Initializes wxTreeLayout. Call from application or overridden {\bf Initialize}
|
||||
or constructor.
|
||||
|
||||
\membersection{wxTreeLayout::NodeActive}\label{wxtreelayoutnodeactive}
|
||||
|
||||
\func{bool}{NodeActive}{\param{long}{ id}}
|
||||
|
||||
Define this so wxTreeLayout can know which nodes are to be drawn (not all
|
||||
nodes may be connected in the tree). See also \helprefn{ActivateNode}{activatenode}.
|
||||
|
||||
\membersection{wxTreeLayout::SetNodeName}
|
||||
|
||||
\func{void}{SetNodeName}{\param{long}{ id}, \param{const wxString\& }{ name}}
|
||||
|
||||
May optionally be defined to set a node's name.
|
||||
|
||||
\membersection{wxTreeLayout::SetNodeX}
|
||||
|
||||
\func{void}{SetNodeX}{\param{long}{ id}, \param{long}{ x}}
|
||||
|
||||
Must be defined to set the current X position of the node. Note that
|
||||
coordinates are assumed to be at the top-left of the node so some conversion
|
||||
may be necessary for your application.
|
||||
|
||||
\membersection{wxTreeLayout::SetNodeY}
|
||||
|
||||
\func{void}{SetNodeY}{\param{long}{ id}, \param{long}{ y}}
|
||||
|
||||
Must be defined to set the current Y position of the node. Note that
|
||||
coordinates are assumed to be at the top-left of the node so some conversion
|
||||
may be necessary for your application.
|
||||
|
||||
\membersection{wxTreeLayout::SetOrientation}
|
||||
|
||||
\func{void}{SetOrientation}{\param{bool}{ orientation}}
|
||||
|
||||
Sets the tree orientation: TRUE means top-to-bottom, FALSE means left-to-right (the default).
|
||||
|
||||
\membersection{wxTreeLayout::SetTopNode}\label{wxtreelayoutsettopnode}
|
||||
|
||||
\func{void}{SetTopNode}{\param{long}{ id}}
|
||||
|
||||
Call this to identify the top of the tree to wxTreeLayout.
|
||||
|
||||
\membersection{wxTreeLayout::SetSpacing}
|
||||
|
||||
\func{void}{SetSpacing}{\param{long}{ x}, \param{long}{ y}}
|
||||
|
||||
Sets the horizontal and vertical spacing between nodes in the tree.
|
||||
|
||||
\membersection{wxTreeLayout::SetMargins}\label{wxtreelayoutsetmargins}
|
||||
|
||||
\func{void}{SetMargins}{\param{long}{ x}, \param{long}{ y}}
|
||||
|
||||
Sets the left and top margins of the whole tree.
|
||||
|
||||
\section{\class{wxLayoutTreeStored}}\label{wxlayouttreestored}
|
||||
|
||||
wxLayoutTreeStored provides storage for node labels, position and client data. It also provides hit-testing
|
||||
(which node a mouse event occurred on). It is usually a more convenient class to use than wxTreeLayout.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxTreeLayout}{wxtreelayout}\\
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxLayoutTree}{wxlayouttree}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxLayoutTreeStored::wxLayoutTreeStored}
|
||||
|
||||
\func{}{wxLayoutTreeStored}{\param{int }{noNodes = 200}}
|
||||
|
||||
Constructor. Specify the maximum number of nodes to be allocated.
|
||||
|
||||
\membersection{wxLayoutTreeStored::AddChild}\label{wxlayouttreestoredaddchild}
|
||||
|
||||
\func{long}{AddChild}{\param{const wxString\&}{ name}, \param{const wxString\&}{ parent = ""}}
|
||||
|
||||
Adds a child with a given parent, returning the node id.
|
||||
|
||||
\membersection{wxLayoutTreeStored::GetClientData}\label{wxlayouttreestoredgetclientdata}
|
||||
|
||||
\constfunc{long}{GetClientData}{\param{long}{ id}}
|
||||
|
||||
Gets the client data for the given node.
|
||||
|
||||
\membersection{wxLayoutTreeStored::GetNode}\label{wxlayouttreestoredgetnode}
|
||||
|
||||
\constfunc{wxStoredNode*}{GetNode}{\param{long}{ id}}
|
||||
|
||||
Returns the wxStoredNode object for the given node id.
|
||||
|
||||
\membersection{wxLayoutTreeStored::GetNodeCount}\label{wxlayouttreestoredgetnodecount}
|
||||
|
||||
\constfunc{int}{GetNodeCount}{\void}
|
||||
|
||||
Returns the current number of nodes.
|
||||
|
||||
\membersection{wxLayoutTreeStored::GetNumNodes}\label{wxlayouttreestoredgetnumnodes}
|
||||
|
||||
\constfunc{int}{GetNumNodes}{\void}
|
||||
|
||||
Returns the maximum number of nodes.
|
||||
|
||||
\membersection{wxLayoutTreeStored::HitTest}\label{wxlayouttreestoredhittest}
|
||||
|
||||
\func{wxString}{HitTest}{\param{wxMouseEvent\&}{ event}, \param{wxDC\& }{dc}}
|
||||
|
||||
Returns a string with the node name corresponding to the position of the mouse event, or the empty string if no node
|
||||
was detected.
|
||||
|
||||
\membersection{wxLayoutTreeStored::NameToId}\label{wxlayouttreestorednametoid}
|
||||
|
||||
\func{long}{NameToId}{\param{const wxString\&}{ name}}
|
||||
|
||||
Returns the id for the given node name, or -1 if there was no such node.
|
||||
|
||||
\membersection{wxLayoutTreeStored::SetClientData}\label{wxlayouttreestoredsetclientdata}
|
||||
|
||||
\func{void}{SetClientData}{\param{long}{ id}, \param{long}{ clientData}}
|
||||
|
||||
Sets client data for the given node.
|
||||
|
BIN
docs/latex/wx/treetst.bmp
Normal file
BIN
docs/latex/wx/treetst.bmp
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
BIN
docs/latex/wx/treetst.gif
Normal file
BIN
docs/latex/wx/treetst.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.4 KiB |
@@ -3,11 +3,8 @@
|
||||
% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidbase.h at 26/Feb/00 14:51:56
|
||||
%
|
||||
|
||||
|
||||
\section{\class{wxVideoBaseDriver}}\label{wxvideobasedriver}
|
||||
|
||||
|
||||
|
||||
Classes definition
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
@@ -1,5 +1,5 @@
|
||||
[OPTIONS]
|
||||
BMROOT=d:\wx2\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
|
||||
BMROOT=d:\wx2\wxWindows\docs\latex\wx ; Assume that bitmaps are where the source is
|
||||
TITLE=wxWindows Manual
|
||||
CONTENTS=Contents
|
||||
COMPRESS=HIGH
|
||||
|
Reference in New Issue
Block a user