X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7a4523c8108ab92f03116b0d5ebdd254f26d2950..03cf4aa61da039f4331bfc788cc07850a50a0df5:/docs/latex/wx/dataviewrenderer.tex?ds=sidebyside diff --git a/docs/latex/wx/dataviewrenderer.tex b/docs/latex/wx/dataviewrenderer.tex index 935423536e..c5a968c0ea 100644 --- a/docs/latex/wx/dataviewrenderer.tex +++ b/docs/latex/wx/dataviewrenderer.tex @@ -7,6 +7,7 @@ render the individual cells. One instance of a renderer class is owned by \helpref{wxDataViewColumn}{wxdataviewcolumn}. There is a number of ready-to-use renderers provided: \helpref{wxDataViewTextRenderer}{wxdataviewtextrenderer}, +\helpref{wxDataViewIconTextRenderer}{wxdataviewicontextrenderer}, \helpref{wxDataViewToggleRenderer}{wxdataviewtogglerenderer}, \helpref{wxDataViewProgressRenderer}{wxdataviewprogressrenderer}, \helpref{wxDataViewBitmapRenderer}{wxdataviewbitmaprenderer}, @@ -16,10 +17,10 @@ Additionally, the user can write own renderers by deriving from \helpref{wxDataViewCustomRenderer}{wxdataviewcustomrenderer}. The {\it wxDataViewCellMode} flag controls, what actions -the cell data allows. {\it wxDATAVIEW_CELL_ACTIVATABLE} +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 +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 @@ -62,6 +63,13 @@ enum wxDataViewCellRenderState +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataViewRenderer::wxDataViewRenderer}\label{wxdataviewrendererwxdataviewrenderer} @@ -135,12 +143,19 @@ in-place editing if desired. \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataViewTextRenderer::wxDataViewTextRenderer}\label{wxdataviewtextrendererwxdataviewtextrenderer} @@ -155,18 +170,101 @@ wxDataViewProgressRenderer \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataViewProgressRenderer::wxDataViewProgressRenderer}\label{wxdataviewprogressrendererwxdataviewprogressrenderer} \func{}{wxDataViewProgressRenderer}{\param{const wxString\& }{label = wxEmptyString}, \param{const wxString\& }{varianttype = wxT("long")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}} +\section{\class{wxDataViewIconText}}\label{wxdataviewicontext} + +wxDataViewIconText is used by +\helpref{wxDataViewIconTextRenderer}{wxdataviewicontextrenderer} +for data transfer. This class can be converted to a from +a \helpref{wxVariant}{wxvariant}. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\membersection{wxDataViewIconText::wxDataViewIconText}\label{wxdataviewicontextwxdataviewicontext} + +\func{}{wxDataViewIconText}{\param{const wxString\& }{text = wxEmptyString}, \param{const wxIcon\& }{icon = wxNullIcon}} + +\func{}{wxDataViewIconText}{\param{const wxDataViewIconText\& }{other}} + +Constructor. + +\membersection{wxDataViewIconText::GetIcon}\label{wxdataviewicontextgeticon} + +\constfunc{const wxIcon\&}{GetIcon}{\void} + +Gets the icon. + +\membersection{wxDataViewIconText::GetText}\label{wxdataviewicontextgettext} + +\constfunc{wxString}{GetText}{\void} + +Gets the text. + +\membersection{wxDataViewIconText::SetIcon}\label{wxdataviewicontextseticon} + +\func{void}{SetIcon}{\param{const wxIcon\& }{icon}} + +Set the icon. + +\membersection{wxDataViewIconText::SetText}\label{wxdataviewicontextsettext} + +\func{void}{SetText}{\param{const wxString\& }{text}} + +Set the text. + +\section{\class{wxDataViewIconTextRenderer}}\label{wxdataviewicontextrenderer} + +The wxDataViewIconTextRenderer class is used to display text with +a small icon next to it as it is typically done in a file manager. +This classes uses the \helpref{wxDataViewIconText}{wxdataviewicontext} +helper class to store its data. wxDataViewIonText can be converted +to a from a \helpref{wxVariant}{wxvariant} using the left shift +operator. + +\wxheading{Derived from} + +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxDataViewIconTextRenderer::wxDataViewIconTextRenderer}\label{wxdataviewtogglerendererwxdataviewicontextrenderer} + +\func{}{wxDataViewIconTextRenderer}{\param{const wxString\& }{varianttype = wxT("wxDataViewIconText")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}} + \section{\class{wxDataViewToggleRenderer}}\label{wxdataviewtogglerenderer} @@ -174,12 +272,19 @@ wxDataViewToggleRenderer \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataViewToggleRenderer::wxDataViewToggleRenderer}\label{wxdataviewtogglerendererwxdataviewtogglerenderer} @@ -192,12 +297,19 @@ wxDataViewBitmapRenderer \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataViewBitmapRenderer::wxDataViewBitmapRenderer}\label{wxdataviewbitmaprendererwxdataviewbitmaprenderer} @@ -211,12 +323,20 @@ wxDataViewDateRenderer \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxDataViewDateRenderer::wxDataViewDateRenderer}\label{wxdataviewdaterendererwxdataviewdaterenderer} \func{}{wxDataViewDateRenderer}{\param{const wxString\& }{varianttype = wxT("datetime")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}} @@ -242,12 +362,20 @@ in order to end the editing. \wxheading{Derived from} -\helpref{wxDataViewRenderer}{wxdataviewrenderer} +\helpref{wxDataViewRenderer}{wxdataviewrenderer}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + +\latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxDataViewCustomRenderer::wxDataViewCustomRenderer}\label{wxdataviewcustomrendererwxdataviewcustomrenderer} \func{}{wxDataViewCustomRenderer}{\param{const wxString\& }{varianttype = wxT("string")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{bool }{no\_init = false}} @@ -270,7 +398,7 @@ 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}} +\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 @@ -307,7 +435,7 @@ from the editor control (pointed to by {\it editor}): \membersection{wxDataViewCustomRenderer::Activate}\label{wxdataviewcustomrendereractivate} -\func{virtual bool}{Activate}{\param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} +\func{virtual bool}{Activate}{\param{wxRect }{cell}, \param{wxDataViewModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} Override this to react to double clicks or . @@ -327,7 +455,7 @@ Return size required to show content. \membersection{wxDataViewCustomRenderer::LeftClick}\label{wxdataviewcustomrendererleftclick} -\func{virtual bool}{LeftClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} +\func{virtual bool}{LeftClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} Overrride this to react to a left click. @@ -341,13 +469,13 @@ so that this instance knows what to render. \membersection{wxDataViewCustomRenderer::RightClick}\label{wxdataviewcustomrendererrightclick} -\func{virtual bool}{RightClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} +\func{virtual bool}{RightClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} Overrride this to react to a right click. \membersection{wxDataViewCustomRenderer::StartDrag}\label{wxdataviewcustomrendererstartdrag} -\func{virtual bool}{StartDrag}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} +\func{virtual bool}{StartDrag}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}} Overrride this to start a drag operation.