From 03817a5e24efdc591f0a89bdded3fcf5add9d0a5 Mon Sep 17 00:00:00 2001 From: Michael Bedward Date: Fri, 21 Jul 2000 08:30:47 +0000 Subject: [PATCH] Trying again to add these files to the main trunk. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@7800 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/gridattr.tex | 170 ++++++++++++++++++++++++++ docs/latex/wx/gridedit.tex | 134 +++++++++++++++++++++ docs/latex/wx/gridrend.tex | 50 ++++++++ docs/latex/wx/gridtbl.tex | 236 +++++++++++++++++++++++++++++++++++++ docs/latex/wx/gridwork.tex | 59 ++++++++++ 5 files changed, 649 insertions(+) create mode 100644 docs/latex/wx/gridattr.tex create mode 100644 docs/latex/wx/gridedit.tex create mode 100644 docs/latex/wx/gridrend.tex create mode 100644 docs/latex/wx/gridtbl.tex create mode 100644 docs/latex/wx/gridwork.tex diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex new file mode 100644 index 0000000000..600dee811b --- /dev/null +++ b/docs/latex/wx/gridattr.tex @@ -0,0 +1,170 @@ +% +% automatically generated by HelpGen from +% grid.h at 11/May/00 18:30:19 +% + + +\section{\class{wxGridCellAttr}}\label{wxgridcellattr} + + + +wxGridCellAttr: this class can be used to alter the cells appearance in +the grid by changing their colour/font/... from default. An object of this +class may be returned by wxGridTable::GetAttr(). + + +\wxheading{Derived from} + +No base class + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr} + +\func{}{wxGridCellAttr}{\void} + +ctors + + +\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr} + +\func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}} + +VZ: considering the number of members wxGridCellAttr has now, this ctor +seems to be pretty useless... may be we should just remove it? + + +\membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone} + +\constfunc{wxGridCellAttr*}{Clone}{\void} + +creates a new copy of this object + + +\membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref} + +\func{void}{IncRef}{\void} + +this class is ref counted: it is created with ref count of 1, so +calling DecRef() once will delete it. Calling IncRef() allows to lock +it until the matching DecRef() is called + + +\membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref} + +\func{void}{DecRef}{\void} + + +\membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour} + +\func{void}{SetTextColour}{\param{const wxColour\& }{colText}} + +setters + + +\membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour} + +\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}} + + +\membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont} + +\func{void}{SetFont}{\param{const wxFont\& }{font}} + + +\membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment} + +\func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}} + + +\membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly} + +\func{void}{SetReadOnly}{\param{bool }{isReadOnly = TRUE}} + + +\membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer} + +\func{void}{SetRenderer}{\param{wxGridCellRenderer* }{renderer}} + +takes ownership of the pointer + + +\membersection{wxGridCellAttr::SetEditor}\label{wxgridcellattrseteditor} + +\func{void}{SetEditor}{\param{wxGridCellEditor* }{editor}} + + +\membersection{wxGridCellAttr::HasTextColour}\label{wxgridcellattrhastextcolour} + +\constfunc{bool}{HasTextColour}{\void} + +accessors + + +\membersection{wxGridCellAttr::HasBackgroundColour}\label{wxgridcellattrhasbackgroundcolour} + +\constfunc{bool}{HasBackgroundColour}{\void} + + +\membersection{wxGridCellAttr::HasFont}\label{wxgridcellattrhasfont} + +\constfunc{bool}{HasFont}{\void} + + +\membersection{wxGridCellAttr::HasAlignment}\label{wxgridcellattrhasalignment} + +\constfunc{bool}{HasAlignment}{\void} + + +\membersection{wxGridCellAttr::HasRenderer}\label{wxgridcellattrhasrenderer} + +\constfunc{bool}{HasRenderer}{\void} + + +\membersection{wxGridCellAttr::HasEditor}\label{wxgridcellattrhaseditor} + +\constfunc{bool}{HasEditor}{\void} + + +\membersection{wxGridCellAttr::GetTextColour}\label{wxgridcellattrgettextcolour} + +\constfunc{const wxColour\&}{GetTextColour}{\void} + + +\membersection{wxGridCellAttr::GetBackgroundColour}\label{wxgridcellattrgetbackgroundcolour} + +\constfunc{const wxColour\&}{GetBackgroundColour}{\void} + + +\membersection{wxGridCellAttr::GetFont}\label{wxgridcellattrgetfont} + +\constfunc{const wxFont\&}{GetFont}{\void} + + +\membersection{wxGridCellAttr::GetAlignment}\label{wxgridcellattrgetalignment} + +\constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}} + + +\membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer} + +\constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}} + + +\membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor} + +\constfunc{wxGridCellEditor*}{GetEditor}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}} + + +\membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly} + +\constfunc{bool}{IsReadOnly}{\void} + + +\membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr} + +\func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}} + diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex new file mode 100644 index 0000000000..67a8e7080b --- /dev/null +++ b/docs/latex/wx/gridedit.tex @@ -0,0 +1,134 @@ +% +% automatically generated by HelpGen from +% grid.h at 11/May/00 18:30:18 +% + + +\section{\class{wxGridCellEditor}}\label{wxgridcelleditor} + + + +wxGridCellEditor: This class is responsible for providing and manipulating +the in-place edit controls for the grid. Instances of wxGridCellEditor +(actually, instances of derived classes since it is an ABC) can be +associated with the cell attributes for individual cells, rows, columns, or +even for the entire grid. + + +\wxheading{Derived from} + +\helpref{wxGridCellWorker}{wxgridcellworker} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor} + +\func{}{wxGridCellEditor}{\void} + + +\membersection{wxGridCellEditor::IsCreated}\label{wxgridcelleditoriscreated} + +\func{bool}{IsCreated}{\void} + + +\membersection{wxGridCellEditor::Create}\label{wxgridcelleditorcreate} + +\func{void}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{wxEvtHandler* }{evtHandler}} + +Creates the actual edit control + + +\membersection{wxGridCellEditor::SetSize}\label{wxgridcelleditorsetsize} + +\func{void}{SetSize}{\param{const wxRect\& }{rect}} + +Size and position the edit control + + +\membersection{wxGridCellEditor::Show}\label{wxgridcelleditorshow} + +\func{void}{Show}{\param{bool }{show}, \param{wxGridCellAttr* }{attr = NULL}} + +Show or hide the edit control, use the specified attributes to set +colours/fonts for it + + +\membersection{wxGridCellEditor::PaintBackground}\label{wxgridcelleditorpaintbackground} + +\func{void}{PaintBackground}{\param{const wxRect\& }{rectCell}, \param{wxGridCellAttr* }{attr}} + +Draws the part of the cell not occupied by the control: the base class +version just fills it with background colour from the attribute + + +\membersection{wxGridCellEditor::BeginEdit}\label{wxgridcelleditorbeginedit} + +\func{void}{BeginEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}} + +Fetch the value from the table and prepare the edit control +to begin editing. Set the focus to the edit control. + + +\membersection{wxGridCellEditor::EndEdit}\label{wxgridcelleditorendedit} + +\func{bool}{EndEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}} + +Complete the editing of the current cell. Returns true if the value has +changed. If necessary, the control may be destroyed. + + +\membersection{wxGridCellEditor::Reset}\label{wxgridcelleditorreset} + +\func{void}{Reset}{\void} + +Reset the value in the control back to its starting value + + +\membersection{wxGridCellEditor::StartingKey}\label{wxgridcelleditorstartingkey} + +\func{void}{StartingKey}{\param{wxKeyEvent\& }{event}} + +If the editor is enabled by pressing keys on the grid, +this will be called to let the editor do something about +that first key if desired. + + +\membersection{wxGridCellEditor::StartingClick}\label{wxgridcelleditorstartingclick} + +\func{void}{StartingClick}{\void} + +if the editor is enabled by clicking on the cell, this method will be +called + + +\membersection{wxGridCellEditor::HandleReturn}\label{wxgridcelleditorhandlereturn} + +\func{void}{HandleReturn}{\param{wxKeyEvent\& }{event}} + +Some types of controls on some platforms may need some help +with the Return key. + + +\membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy} + +\func{void}{Destroy}{\void} + +Final cleanup + + +\membersection{wxGridCellEditor::Clone}\label{wxgridcelleditorclone} + +\constfunc{wxGridCellEditor*}{Clone}{\void} + +create a new object which is the copy of this one + + +\membersection{wxGridCellEditor::\destruct{wxGridCellEditor}}\label{wxgridcelleditordtor} + +\func{}{\destruct{wxGridCellEditor}}{\void} + +the dtor is private because only DecRef() can delete us + diff --git a/docs/latex/wx/gridrend.tex b/docs/latex/wx/gridrend.tex new file mode 100644 index 0000000000..eed5aa38e8 --- /dev/null +++ b/docs/latex/wx/gridrend.tex @@ -0,0 +1,50 @@ +% +% automatically generated by HelpGen from +% grid.h at 11/May/00 18:30:18 +% + + +\section{\class{wxGridCellRenderer}}\label{wxgridcellrenderer} + + +suppress the stupid gcc warning about the class having private dtor and +no friends + +wxGridCellRenderer: this class is responsible for actually drawing the cell +in the grid. You may pass it to the wxGridCellAttr (below) to change the +format of one given cell or to wxGrid::SetDefaultRenderer() to change the +view of all cells. This is an ABC, you will normally use one of the +predefined derived classes or derive your own class from it. + + +\wxheading{Derived from} + +\helpref{wxGridCellWorker}{wxgridcellworker} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxGridCellRenderer::Draw}\label{wxgridcellrendererdraw} + +\func{void}{Draw}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{row}, \param{int }{col}, \param{bool }{isSelected}} + +draw the given cell on the provided DC inside the given rectangle +using the style specified by the attribute and the default or selected +state corresponding to the isSelected value. +this pure virtual function has a default implementation which will +prepare the DC using the given attribute: it will draw the rectangle +with the bg colour from attr and set the text colour and font + + +\membersection{wxGridCellRenderer::GetBestSize}\label{wxgridcellrenderergetbestsize} + +\func{wxSize}{GetBestSize}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{int }{row}, \param{int }{col}} + +get the preferred size of the cell for its contents + + +\membersection{wxGridCellRenderer::Clone}\label{wxgridcellrendererclone} + +\constfunc{wxGridCellRenderer*}{Clone}{ \ No newline at end of file diff --git a/docs/latex/wx/gridtbl.tex b/docs/latex/wx/gridtbl.tex new file mode 100644 index 0000000000..223e826450 --- /dev/null +++ b/docs/latex/wx/gridtbl.tex @@ -0,0 +1,236 @@ +\section{\class{wxGridTableBase}}\label{wxgridtablebase} + + +Grid table classes + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxGridTableBase::wxGridTableBase}\label{wxgridtablebasewxgridtablebase} + +\func{}{wxGridTableBase}{\void} + + +\membersection{wxGridTableBase::\destruct{wxGridTableBase}}\label{wxgridtablebasedtor} + +\func{}{\destruct{wxGridTableBase}}{\void} + + +\membersection{wxGridTableBase::GetNumberRows}\label{wxgridtablebasegetnumberrows} + +\func{int}{GetNumberRows}{\void} + +You must override these functions in a derived table class + + +\membersection{wxGridTableBase::GetNumberCols}\label{wxgridtablebasegetnumbercols} + +\func{int}{GetNumberCols}{\void} + + +\membersection{wxGridTableBase::IsEmptyCell}\label{wxgridtablebaseisemptycell} + +\func{bool}{IsEmptyCell}{\param{int }{row}, \param{int }{col}} + + +\membersection{wxGridTableBase::GetValue}\label{wxgridtablebasegetvalue} + +\func{wxString}{GetValue}{\param{int }{row}, \param{int }{col}} + + +\membersection{wxGridTableBase::SetValue}\label{wxgridtablebasesetvalue} + +\func{void}{SetValue}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{value}} + + +\membersection{wxGridTableBase::GetTypeName}\label{wxgridtablebasegettypename} + +\func{wxString}{GetTypeName}{\param{int }{row}, \param{int }{col}} + +Data type determination and value access + + +\membersection{wxGridTableBase::CanGetValueAs}\label{wxgridtablebasecangetvalueas} + +\func{bool}{CanGetValueAs}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}} + + +\membersection{wxGridTableBase::CanSetValueAs}\label{wxgridtablebasecansetvalueas} + +\func{bool}{CanSetValueAs}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}} + + +\membersection{wxGridTableBase::GetValueAsLong}\label{wxgridtablebasegetvalueaslong} + +\func{long}{GetValueAsLong}{\param{int }{row}, \param{int }{col}} + + +\membersection{wxGridTableBase::GetValueAsDouble}\label{wxgridtablebasegetvalueasdouble} + +\func{double}{GetValueAsDouble}{\param{int }{row}, \param{int }{col}} + + +\membersection{wxGridTableBase::GetValueAsBool}\label{wxgridtablebasegetvalueasbool} + +\func{bool}{GetValueAsBool}{\param{int }{row}, \param{int }{col}} + + +\membersection{wxGridTableBase::SetValueAsLong}\label{wxgridtablebasesetvalueaslong} + +\func{void}{SetValueAsLong}{\param{int }{row}, \param{int }{col}, \param{long }{value}} + + +\membersection{wxGridTableBase::SetValueAsDouble}\label{wxgridtablebasesetvalueasdouble} + +\func{void}{SetValueAsDouble}{\param{int }{row}, \param{int }{col}, \param{double }{value}} + + +\membersection{wxGridTableBase::SetValueAsBool}\label{wxgridtablebasesetvalueasbool} + +\func{void}{SetValueAsBool}{\param{int }{row}, \param{int }{col}, \param{bool }{value}} + + +\membersection{wxGridTableBase::GetValueAsCustom}\label{wxgridtablebasegetvalueascustom} + +\func{void*}{GetValueAsCustom}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}} + +For user defined types + + +\membersection{wxGridTableBase::SetValueAsCustom}\label{wxgridtablebasesetvalueascustom} + +\func{void}{SetValueAsCustom}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}, \param{void* }{value}} + + +\membersection{wxGridTableBase::SetView}\label{wxgridtablebasesetview} + +\func{void}{SetView}{\param{wxGrid* }{grid}} + +Overriding these is optional + + +\membersection{wxGridTableBase::GetView}\label{wxgridtablebasegetview} + +\constfunc{wxGrid *}{GetView}{\void} + + +\membersection{wxGridTableBase::Clear}\label{wxgridtablebaseclear} + +\func{void}{Clear}{\void} + + +\membersection{wxGridTableBase::InsertRows}\label{wxgridtablebaseinsertrows} + +\func{bool}{InsertRows}{\param{size\_t }{pos = 0}, \param{size\_t }{numRows = 1}} + + +\membersection{wxGridTableBase::AppendRows}\label{wxgridtablebaseappendrows} + +\func{bool}{AppendRows}{\param{size\_t }{numRows = 1}} + + +\membersection{wxGridTableBase::DeleteRows}\label{wxgridtablebasedeleterows} + +\func{bool}{DeleteRows}{\param{size\_t }{pos = 0}, \param{size\_t }{numRows = 1}} + + +\membersection{wxGridTableBase::InsertCols}\label{wxgridtablebaseinsertcols} + +\func{bool}{InsertCols}{\param{size\_t }{pos = 0}, \param{size\_t }{numCols = 1}} + + +\membersection{wxGridTableBase::AppendCols}\label{wxgridtablebaseappendcols} + +\func{bool}{AppendCols}{\param{size\_t }{numCols = 1}} + + +\membersection{wxGridTableBase::DeleteCols}\label{wxgridtablebasedeletecols} + +\func{bool}{DeleteCols}{\param{size\_t }{pos = 0}, \param{size\_t }{numCols = 1}} + + +\membersection{wxGridTableBase::GetRowLabelValue}\label{wxgridtablebasegetrowlabelvalue} + +\func{wxString}{GetRowLabelValue}{\param{int }{row}} + + +\membersection{wxGridTableBase::GetColLabelValue}\label{wxgridtablebasegetcollabelvalue} + +\func{wxString}{GetColLabelValue}{\param{int }{col}} + + +\membersection{wxGridTableBase::SetRowLabelValue}\label{wxgridtablebasesetrowlabelvalue} + +\func{void}{SetRowLabelValue}{\param{int }{WXUNUSED(row)}, \param{const }{wxString\&}} + + +\membersection{wxGridTableBase::SetColLabelValue}\label{wxgridtablebasesetcollabelvalue} + +\func{void}{SetColLabelValue}{\param{int }{WXUNUSED(col)}, \param{const }{wxString\&}} + + +\membersection{wxGridTableBase::SetAttrProvider}\label{wxgridtablebasesetattrprovider} + +\func{void}{SetAttrProvider}{\param{wxGridCellAttrProvider* }{attrProvider}} + +Attribute handling +give us the attr provider to use - we take ownership of the pointer + + +\membersection{wxGridTableBase::GetAttrProvider}\label{wxgridtablebasegetattrprovider} + +\constfunc{wxGridCellAttrProvider*}{GetAttrProvider}{\void} + +get the currently used attr provider (may be NULL) + + +\membersection{wxGridTableBase::CanHaveAttributes}\label{wxgridtablebasecanhaveattributes} + +\func{bool}{CanHaveAttributes}{\void} + +Does this table allow attributes? Default implementation creates +a wxGridCellAttrProvider if necessary. + + +\membersection{wxGridTableBase::UpdateAttrRows}\label{wxgridtablebaseupdateattrrows} + +\func{void}{UpdateAttrRows}{\param{size\_t }{pos}, \param{int }{numRows}} + +change row/col number in attribute if needed + + +\membersection{wxGridTableBase::UpdateAttrCols}\label{wxgridtablebaseupdateattrcols} + +\func{void}{UpdateAttrCols}{\param{size\_t }{pos}, \param{int }{numCols}} + + +\membersection{wxGridTableBase::GetAttr}\label{wxgridtablebasegetattr} + +\func{wxGridCellAttr*}{GetAttr}{\param{int }{row}, \param{int }{col}} + +by default forwarded to wxGridCellAttrProvider if any. May be +overridden to handle attributes directly in the table. + + +\membersection{wxGridTableBase::SetAttr}\label{wxgridtablebasesetattr} + +\func{void}{SetAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{row}, \param{int }{col}} + +these functions take ownership of the pointer + + +\membersection{wxGridTableBase::SetRowAttr}\label{wxgridtablebasesetrowattr} + +\func{void}{SetRowAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{row}} + + +\membersection{wxGridTableBase::SetColAttr}\label{wxgridtablebasesetcolattr} + +\func{void}{SetColAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{col}} + diff --git a/docs/latex/wx/gridwork.tex b/docs/latex/wx/gridwork.tex new file mode 100644 index 0000000000..c8dcc258a3 --- /dev/null +++ b/docs/latex/wx/gridwork.tex @@ -0,0 +1,59 @@ +% +% automatically generated by HelpGen from +% grid.h at 11/May/00 18:30:18 +% + + +\section{\class{wxGridCellWorker}}\label{wxgridcellworker} + + + +wxGridCellWorker: common base class for wxGridCellRenderer and +wxGridCellEditor +NB: this is more an implementation convenience than a design issue, so this +class is not documented and is not public at all + + +\wxheading{Derived from} + +No base class + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxGridCellWorker::wxGridCellWorker}\label{wxgridcellworkerwxgridcellworker} + +\func{}{wxGridCellWorker}{\void} + + +\membersection{wxGridCellWorker::IncRef}\label{wxgridcellworkerincref} + +\func{void}{IncRef}{\void} + +this class is ref counted: it is created with ref count of 1, so +calling DecRef() once will delete it. Calling IncRef() allows to lock +it until the matching DecRef() is called + + +\membersection{wxGridCellWorker::DecRef}\label{wxgridcellworkerdecref} + +\func{void}{DecRef}{\void} + + +\membersection{wxGridCellWorker::SetParameters}\label{wxgridcellworkersetparameters} + +\func{void}{SetParameters}{\param{const wxString\& }{params}} + +interpret renderer parameters: arbitrary string whose interpretatin is +left to the derived classes + + +\membersection{wxGridCellWorker::\destruct{wxGridCellWorker}}\label{wxgridcellworkerdtor} + +\func{}{\destruct{wxGridCellWorker}}{\void} + +virtual dtor for any base class - private because only DecRef() can +delete us + -- 2.45.2