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

\section{\class{wxPropertyView}}\label{wxpropertyview}

The {\bf wxPropertyView} abstract class is the base class for views
of property sheets, acting as intermediaries between properties and
actual windows.

\wxheading{See also}

\helpref{wxPropertyView overview}{wxpropertyviewoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxPropertyView::wxPropertyView}

\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}

Constructor.

The {\it flags} argument can be a bit list of the following:

\begin{itemize}\itemsep=0pt
\item wxPROP\_BUTTON\_CLOSE
\item wxPROP\_BUTTON\_OK
\item wxPROP\_BUTTON\_CANCEL
\item wxPROP\_BUTTON\_CHECK\_CROSS
\item wxPROP\_BUTTON\_HELP
\item wxPROP\_DYNAMIC\_VALUE\_FIELD
\item wxPROP\_PULLDOWN
\end{itemize}

\membersection{wxPropertyView::\destruct{wxPropertyView}}

\func{void}{\destruct{wxPropertyView}}{\void}

Destructor.

\membersection{wxPropertyView::AddRegistry}\label{wxpropertyviewaddregistry}

\func{void}{AddRegistry}{\param{wxPropertyValidatorRegistry *}{registry}}

Adds a registry (list of property validators) the view's list of registries, which is initially empty.

\membersection{wxPropertyView::FindPropertyValidator}\label{wxpropertyviewfindpropertyvalidator}

\func{wxPropertyValidator *}{FindPropertyValidator}{\param{wxProperty *}{property}}

Finds the property validator that is most appropriate to this property.

\membersection{wxPropertyView::GetPropertySheet}\label{wxpropertyviewgetpropertysheet}

\func{wxPropertySheet *}{GetPropertySheet}{\void}

Gets the property sheet for this view.

\membersection{wxPropertyView::GetRegistryList}\label{wxpropertyviewgetregistrylist}

\func{wxList\&}{GetRegistryList}{\void}

Returns a reference to the list of property validator registries.

\membersection{wxPropertyView::OnOk}\label{wxpropertyviewonok}

\func{void}{OnOk}{\void}

Virtual function that will be called when the OK button on the physical window is pressed (if it exists).

\membersection{wxPropertyView::OnCancel}\label{wxpropertyviewoncancel}

\func{void}{OnCancel}{\void}

Virtual function that will be called when the Cancel button on the physical window is pressed (if it exists).

\membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose}

\func{bool}{OnClose}{\void}

Virtual function that will be called when the physical window is closed. The default implementation returns false.

\membersection{wxPropertyView::OnHelp}\label{wxpropertyviewonhelp}

\func{void}{OnHelp}{\void}

Virtual function that will be called when the Help button on the physical window is pressed (if it exists).

\membersection{wxPropertyView::OnPropertyChanged}\label{wxpropertyviewonpropertychanged}

\func{void}{OnPropertyChanged}{\param{wxProperty *}{property}}

Virtual function called by a view or validator when a property's value changed. Validators
must be written correctly for this to be called. You can override this function
to respond immediately to property value changes.

\membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview}

\func{bool}{OnUpdateView}{\void}

Called by the viewed object to update the view. The default implementation just returns
false.

\membersection{wxPropertyView::SetPropertySheet}\label{wxpropertyviewsetpropertysheet}

\func{void}{SetPropertySheet}{\param{wxPropertySheet *}{sheet}}

Sets the property sheet for this view.

\membersection{wxPropertyView::ShowView}\label{wxpropertyviewshowview}

\func{void}{ShowView}{\param{wxPropertySheet *}{sheet}, \param{wxPanel *}{panel}}

Associates this view with the given panel, and shows the view.
Commit	Line	Data
200fed6c VS	1	\section{\class{wxPropertyView}}\label{wxpropertyview}
200fed6c VS	2
200fed6c VS	3	The {\bf wxPropertyView} abstract class is the base class for views
	4	of property sheets, acting as intermediaries between properties and
	5	actual windows.
	6
fa482912 JS	7	\wxheading{See also}
	8
	9	\helpref{wxPropertyView overview}{wxpropertyviewoverview}
	10
	11	\latexignore{\rtfignore{\wxheading{Members}}}
	12
200fed6c VS	13	\membersection{wxPropertyView::wxPropertyView}
	14
	15	\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
	16
	17	Constructor.
	18
	19	The {\it flags} argument can be a bit list of the following:
	20
	21	\begin{itemize}\itemsep=0pt
	22	\item wxPROP\_BUTTON\_CLOSE
	23	\item wxPROP\_BUTTON\_OK
	24	\item wxPROP\_BUTTON\_CANCEL
	25	\item wxPROP\_BUTTON\_CHECK\_CROSS
	26	\item wxPROP\_BUTTON\_HELP
	27	\item wxPROP\_DYNAMIC\_VALUE\_FIELD
	28	\item wxPROP\_PULLDOWN
	29	\end{itemize}
	30
	31	\membersection{wxPropertyView::\destruct{wxPropertyView}}
	32
	33	\func{void}{\destruct{wxPropertyView}}{\void}
	34
	35	Destructor.
	36
	37	\membersection{wxPropertyView::AddRegistry}\label{wxpropertyviewaddregistry}
	38
	39	\func{void}{AddRegistry}{\param{wxPropertyValidatorRegistry *}{registry}}
	40
	41	Adds a registry (list of property validators) the view's list of registries, which is initially empty.
	42
	43	\membersection{wxPropertyView::FindPropertyValidator}\label{wxpropertyviewfindpropertyvalidator}
	44
	45	\func{wxPropertyValidator }{FindPropertyValidator}{\param{wxProperty }{property}}
	46
	47	Finds the property validator that is most appropriate to this property.
	48
	49	\membersection{wxPropertyView::GetPropertySheet}\label{wxpropertyviewgetpropertysheet}
	50
	51	\func{wxPropertySheet *}{GetPropertySheet}{\void}
	52
	53	Gets the property sheet for this view.
	54
	55	\membersection{wxPropertyView::GetRegistryList}\label{wxpropertyviewgetregistrylist}
	56
	57	\func{wxList\&}{GetRegistryList}{\void}
	58
	59	Returns a reference to the list of property validator registries.
	60
	61	\membersection{wxPropertyView::OnOk}\label{wxpropertyviewonok}
	62
	63	\func{void}{OnOk}{\void}
	64
	65	Virtual function that will be called when the OK button on the physical window is pressed (if it exists).
	66
	67	\membersection{wxPropertyView::OnCancel}\label{wxpropertyviewoncancel}
	68
	69	\func{void}{OnCancel}{\void}
	70
	71	Virtual function that will be called when the Cancel button on the physical window is pressed (if it exists).
	72
	73	\membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose}
	74
fa482912	75	\func{bool}{OnClose}{\void}
200fed6c	76
cc81d32f	77	Virtual function that will be called when the physical window is closed. The default implementation returns false.
200fed6c VS	78
	79	\membersection{wxPropertyView::OnHelp}\label{wxpropertyviewonhelp}
	80
	81	\func{void}{OnHelp}{\void}
	82
	83	Virtual function that will be called when the Help button on the physical window is pressed (if it exists).
	84
	85	\membersection{wxPropertyView::OnPropertyChanged}\label{wxpropertyviewonpropertychanged}
	86
	87	\func{void}{OnPropertyChanged}{\param{wxProperty *}{property}}
	88
	89	Virtual function called by a view or validator when a property's value changed. Validators
	90	must be written correctly for this to be called. You can override this function
	91	to respond immediately to property value changes.
	92
	93	\membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview}
	94
fa482912	95	\func{bool}{OnUpdateView}{\void}
200fed6c VS	96
200fed6c VS	97	Called by the viewed object to update the view. The default implementation just returns
cc81d32f	98	false.
200fed6c VS	99
	100	\membersection{wxPropertyView::SetPropertySheet}\label{wxpropertyviewsetpropertysheet}
	101
	102	\func{void}{SetPropertySheet}{\param{wxPropertySheet *}{sheet}}
	103
	104	Sets the property sheet for this view.
	105
	106	\membersection{wxPropertyView::ShowView}\label{wxpropertyviewshowview}
	107
	108	\func{void}{ShowView}{\param{wxPropertySheet }{sheet}, \param{wxPanel }{panel}}
	109
	110	Associates this view with the given panel, and shows the view.
	111