fixed doc wrong position of \wxheading{Library}

[wxWidgets.git] / docs / latex / wx / dataviewrenderer.tex

diff --git a/docs/latex/wx/dataviewrenderer.tex b/docs/latex/wx/dataviewrenderer.tex
index 50900ec2185b1d88dea34e442ea1f5cc86028cdf..23723487916b3120bf34e16ae2696c5d00067111 100644 (file)
--- a/docs/latex/wx/dataviewrenderer.tex
+++ b/docs/latex/wx/dataviewrenderer.tex
@@ -12,13 +12,20 @@ a number of ready-to-use renderers provided:
 \helpref{wxDataViewBitmapRenderer}{wxdataviewbitmaprenderer},
 \helpref{wxDataViewDateRenderer}{wxdataviewdaterenderer}.
 
 \helpref{wxDataViewBitmapRenderer}{wxdataviewbitmaprenderer},
 \helpref{wxDataViewDateRenderer}{wxdataviewdaterenderer}.
 

-

 Additionally, the user can write own renderers by deriving from
 \helpref{wxDataViewCustomRenderer}{wxdataviewcustomrenderer}.
 
 Additionally, the user can write own renderers by deriving from
 \helpref{wxDataViewCustomRenderer}{wxdataviewcustomrenderer}.
 

-These flags control the behaviour of the renderer and they
-are used for controlling in what mode the renderer shall
-render its contents:
+The {\it wxDataViewCellMode} flag controls, what actions
+the cell data allows. {\it wxDATAVIEW\_CELL\_ACTIVATABLE}
+indicates that the user can double click the cell and
+something will happen (e.g. a window for editing a date
+will pop up). {\it wxDATAVIEW\_CELL\_EDITABLE} indicates
+that the user can edit the data in-place, i.e. an control
+will show up after a slow click on the cell. This behaviour
+is best known from changing the filename in most file 
+managers etc.
+
+

 
 {\small
 \begin{verbatim}
 
 {\small
 \begin{verbatim}


@@ -28,7 +35,14 @@ enum wxDataViewCellMode
     wxDATAVIEW_CELL_ACTIVATABLE,
     wxDATAVIEW_CELL_EDITABLE
 };
     wxDATAVIEW_CELL_ACTIVATABLE,
     wxDATAVIEW_CELL_EDITABLE
 };

+\end{verbatim}
+}
+
+The {\it wxDataViewCellRenderState} flag controls how the
+the renderer should display its contents in a cell:

 
 

+{\small
+\begin{verbatim}

 enum wxDataViewCellRenderState
 {
     wxDATAVIEW_CELL_SELECTED    = 1,
 enum wxDataViewCellRenderState
 {
     wxDATAVIEW_CELL_SELECTED    = 1,


@@ -48,6 +62,10 @@ enum wxDataViewCellRenderState
 
 <wx/dataview.h>
 
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 
 \membersection{wxDataViewRenderer::wxDataViewRenderer}\label{wxdataviewrendererwxdataviewrenderer}
 
 
 \membersection{wxDataViewRenderer::wxDataViewRenderer}\label{wxdataviewrendererwxdataviewrenderer}
 


@@ -101,22 +119,37 @@ The internal code will then render this cell with this data.
 
 \func{virtual bool}{Validate}{\param{wxVariant\& }{value}}
 
 
 \func{virtual bool}{Validate}{\param{wxVariant\& }{value}}
 

-To be implemented.
+Before data is committed to the data model, it is passed to this
+method where it can be checked for validity. This can also be
+used for checking a valid range or limiting the user input in
+a certain aspect (e.g. max number of characters or only alphanumeric
+input, ASCII only etc.). Return {\it false} if the value is
+not valid.
+
+Please note that due to implementation limitations, this validation
+is done after the editing control already is destroyed and the
+editing process finished.

 
 
 \section{\class{wxDataViewTextRenderer}}\label{wxdataviewtextrenderer}
 
 
 
 \section{\class{wxDataViewTextRenderer}}\label{wxdataviewtextrenderer}
 

-wxDataViewTextRenderer
+wxDataViewTextRenderer is used for rendering text. It supports
+in-place editing if desired.

 
 
 \wxheading{Derived from}
 
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 
 \membersection{wxDataViewTextRenderer::wxDataViewTextRenderer}\label{wxdataviewtextrendererwxdataviewtextrenderer}
 
 
 \membersection{wxDataViewTextRenderer::wxDataViewTextRenderer}\label{wxdataviewtextrendererwxdataviewtextrenderer}
 


@@ -131,12 +164,17 @@ wxDataViewProgressRenderer
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 
 \membersection{wxDataViewProgressRenderer::wxDataViewProgressRenderer}\label{wxdataviewprogressrendererwxdataviewprogressrenderer}
 
 
 \membersection{wxDataViewProgressRenderer::wxDataViewProgressRenderer}\label{wxdataviewprogressrendererwxdataviewprogressrenderer}
 


@@ -150,12 +188,17 @@ wxDataViewToggleRenderer
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 
 \membersection{wxDataViewToggleRenderer::wxDataViewToggleRenderer}\label{wxdataviewtogglerendererwxdataviewtogglerenderer}
 
 
 \membersection{wxDataViewToggleRenderer::wxDataViewToggleRenderer}\label{wxdataviewtogglerendererwxdataviewtogglerenderer}
 


@@ -168,12 +211,17 @@ wxDataViewBitmapRenderer
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 
 \membersection{wxDataViewBitmapRenderer::wxDataViewBitmapRenderer}\label{wxdataviewbitmaprendererwxdataviewbitmaprenderer}
 
 
 \membersection{wxDataViewBitmapRenderer::wxDataViewBitmapRenderer}\label{wxdataviewbitmaprendererwxdataviewbitmaprenderer}
 


@@ -187,12 +235,17 @@ wxDataViewDateRenderer
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 \membersection{wxDataViewDateRenderer::wxDataViewDateRenderer}\label{wxdataviewdaterendererwxdataviewdaterenderer}
 
 \func{}{wxDataViewDateRenderer}{\param{const wxString\& }{varianttype = wxT("datetime")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}}
 \membersection{wxDataViewDateRenderer::wxDataViewDateRenderer}\label{wxdataviewdaterendererwxdataviewdaterenderer}
 
 \func{}{wxDataViewDateRenderer}{\param{const wxString\& }{varianttype = wxT("datetime")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}}


@@ -200,16 +253,35 @@ wxDataViewDateRenderer
 
 \section{\class{wxDataViewCustomRenderer}}\label{wxdataviewcustomrenderer}
 
 
 \section{\class{wxDataViewCustomRenderer}}\label{wxdataviewcustomrenderer}
 

-wxDataViewCustomRenderer
+You need to derive a new class from wxDataViewCustomRenderer in
+order to write a new renderer. You need to override at least 
+\helpref{SetValue}{wxdataviewrenderersetvalue},
+\helpref{GetValue}{wxdataviewrenderergetvalue}, 
+\helpref{GetSize}{wxdataviewcustomrenderergetsize}
+and \helpref{Render}{wxdataviewcustomrendererrender}.
+
+If you want your renderer to support in-place editing then you
+also need to override 
+\helpref{HasEditorCtrl}{wxdataviewcustomrendererhaseditorctrl},
+\helpref{CreateEditorCtrl}{wxdataviewcustomrenderercreateeditorctrl}
+and \helpref{GetValueFromEditorCtrl}{wxdataviewcustomrenderergetvaluefromeditorctrl}.
+Note that a special event handler will be pushed onto that
+editor control which handles <ENTER> and focus out events
+in order to end the editing.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxDataViewRenderer}{wxdataviewrenderer}
+\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/dataview.h>
 
 
 \wxheading{Include files}
 
 <wx/dataview.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 \membersection{wxDataViewCustomRenderer::wxDataViewCustomRenderer}\label{wxdataviewcustomrendererwxdataviewcustomrenderer}
 
 \func{}{wxDataViewCustomRenderer}{\param{const wxString\& }{varianttype = wxT("string")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{bool }{no\_init = false}}
 \membersection{wxDataViewCustomRenderer::wxDataViewCustomRenderer}\label{wxdataviewcustomrendererwxdataviewcustomrenderer}
 
 \func{}{wxDataViewCustomRenderer}{\param{const wxString\& }{varianttype = wxT("string")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{bool }{no\_init = false}}


@@ -222,6 +294,51 @@ Constructor.
 
 Destructor.
 
 
 Destructor.
 

+
+\membersection{wxDataViewCustomRenderer::HasEditorCtrl}\label{wxdataviewcustomrendererhaseditorctrl}
+
+\func{virtual bool}{HasEditorCtrl}{\void}
+
+Override this and make it return {\it true} in order to
+indicate that this renderer supports in-place editing.
+
+\membersection{wxDataViewCustomRenderer::CreateEditorCtrl}\label{wxdataviewcustomrenderercreateeditorctrl}
+
+\func{virtual wxControl*}{CreateEditorCtrl}{\param{wxWindow *}{parent}, \param{wxRect }{labelRect}, \param{const wxVariant \& }{value}}
+
+Override this to create the actual editor control once editing
+is about to start. {\it parent} is the parent of the editor
+control, {\it labelRect} indicates the position and
+size of the editor control and {\it value} is its initial value:
+
+{\small
+\begin{verbatim}
+{ 
+    long l = value;
+    return new wxSpinCtrl( parent, wxID_ANY, wxEmptyString, 
+                 labelRect.GetTopLeft(), labelRect.GetSize(), 0, 0, 100, l );
+}
+\end{verbatim}
+}
+
+\membersection{wxDataViewCustomRenderer::GetValueFromEditorCtrl}\label{wxdataviewcustomrenderergetvaluefromeditorctrl}
+
+\func{virtual bool}{GetValueFromEditorCtrl}{\param{wxControl* }{editor}, \param{wxVariant \& }{value}}
+
+Overrride this so that the renderer can get the value 
+from the editor control (pointed to by {\it editor}):
+
+{\small
+\begin{verbatim}
+{ 
+    wxSpinCtrl *sc = (wxSpinCtrl*) editor;
+    long l = sc->GetValue();
+    value = l;
+    return true;
+}
+\end{verbatim}
+}
+

 \membersection{wxDataViewCustomRenderer::Activate}\label{wxdataviewcustomrendereractivate}
 
 \func{virtual bool}{Activate}{\param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}
 \membersection{wxDataViewCustomRenderer::Activate}\label{wxdataviewcustomrendereractivate}
 
 \func{virtual bool}{Activate}{\param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}