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

\section{\class{wxPropertyFormView}}\label{wxpropertyformview}

The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
box which has already been created.

\wxheading{See also}

\helpref{wxPropertyFormView overview}{wxpropertyformviewoverview}

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

\membersection{wxPropertyFormView::wxPropertyFormView}

\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}

Constructor.

\membersection{wxPropertyFormView::\destruct{wxPropertyFormView}}

\func{void}{\destruct{wxPropertyFormView}}{\void}

Destructor.

\membersection{wxPropertyFormView::AssociateNames}\label{wxpropertyformviewassociatenames}

\func{void}{AssociateNames}{\void}

Associates the properties with the controls on the panel. For each panel item, if the
panel item name is the same as a property name, the two objects will be associated.
This function should be called manually since the programmer may wish to do the
association manually.

\membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck}

\func{bool}{Check}{\void}

Checks all properties by calling the appropriate validators; returns false if a validation failed.

\membersection{wxPropertyFormView::GetPanel}\label{wxpropertyformviewgetpanel}

\func{wxPanel *}{GetPanel}{\void}

Returns the panel associated with the view.

\membersection{wxPropertyFormView::GetManagedWindow}\label{wxpropertyformviewgetmanagedwindow}

\func{wxWindow *}{GetManagedWindow}{\void}

Returns the managed window (a frame or dialog) associated with the view.

\membersection{wxPropertyFormView::OnOk}\label{wxpropertyformviewonok}

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

Virtual function that will be called when the OK button on the physical window is pressed.
By default, checks and updates the form values, closes and deletes the frame or dialog, then deletes the view.

\membersection{wxPropertyFormView::OnCancel}\label{wxpropertyformviewoncancel}

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

Virtual function that will be called when the Cancel button on the physical window is pressed.
By default, closes and deletes the frame or dialog, then deletes the view.

\membersection{wxPropertyFormView::OnHelp}\label{wxpropertyformviewonhelp}

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

Virtual function that will be called when the Help button on the physical window is pressed.
This needs to be overridden by the application for anything interesting to happen.

\membersection{wxPropertyFormView::OnRevert}\label{wxpropertyformviewonrevert}

\func{void}{OnRevert}{\void}

Virtual function that will be called when the Revert button on the physical window is pressed.
By default transfers the wxProperty values to the panel items (in effect
undoing any unsaved changes in the items).

\membersection{wxPropertyFormView::OnUpdate}\label{wxpropertyformviewonupdate}

\func{void}{OnUpdate}{\void}

Virtual function that will be called when the Update button on the physical window is pressed.
By defaults transfers the displayed values to the wxProperty objects.

\membersection{wxPropertyFormView::SetManagedWindow}\label{wxpropertyformviewsetmanagedwindow}

\func{void}{SetManagedWindow}{\param{wxWindow *}{win}}

Sets the managed window (a frame or dialog) associated with the view.

\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}

\func{bool}{TransferToDialog}{\void}

Transfers property values to the controls in the dialog.

\membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet}

\func{bool}{TransferToPropertySheet}{\void}

Transfers property values from the controls in the dialog to the property sheet.
Commit	Line	Data
200fed6c VS	1	\section{\class{wxPropertyFormView}}\label{wxpropertyformview}
200fed6c VS	2
200fed6c VS	3	The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
	4	box which has already been created.
	5
fa482912 JS	6	\wxheading{See also}
	7
	8	\helpref{wxPropertyFormView overview}{wxpropertyformviewoverview}
	9
	10	\latexignore{\rtfignore{\wxheading{Members}}}
	11
200fed6c VS	12	\membersection{wxPropertyFormView::wxPropertyFormView}
	13
	14	\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}
	15
	16	Constructor.
	17
	18	\membersection{wxPropertyFormView::\destruct{wxPropertyFormView}}
	19
	20	\func{void}{\destruct{wxPropertyFormView}}{\void}
	21
	22	Destructor.
	23
	24	\membersection{wxPropertyFormView::AssociateNames}\label{wxpropertyformviewassociatenames}
	25
	26	\func{void}{AssociateNames}{\void}
	27
	28	Associates the properties with the controls on the panel. For each panel item, if the
	29	panel item name is the same as a property name, the two objects will be associated.
	30	This function should be called manually since the programmer may wish to do the
	31	association manually.
	32
	33	\membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck}
	34
fa482912	35	\func{bool}{Check}{\void}
200fed6c	36
cc81d32f	37	Checks all properties by calling the appropriate validators; returns false if a validation failed.
200fed6c VS	38
	39	\membersection{wxPropertyFormView::GetPanel}\label{wxpropertyformviewgetpanel}
	40
	41	\func{wxPanel *}{GetPanel}{\void}
	42
	43	Returns the panel associated with the view.
	44
	45	\membersection{wxPropertyFormView::GetManagedWindow}\label{wxpropertyformviewgetmanagedwindow}
	46
	47	\func{wxWindow *}{GetManagedWindow}{\void}
	48
	49	Returns the managed window (a frame or dialog) associated with the view.
	50
	51	\membersection{wxPropertyFormView::OnOk}\label{wxpropertyformviewonok}
	52
	53	\func{void}{OnOk}{\void}
	54
	55	Virtual function that will be called when the OK button on the physical window is pressed.
	56	By default, checks and updates the form values, closes and deletes the frame or dialog, then deletes the view.
	57
	58	\membersection{wxPropertyFormView::OnCancel}\label{wxpropertyformviewoncancel}
	59
	60	\func{void}{OnCancel}{\void}
	61
	62	Virtual function that will be called when the Cancel button on the physical window is pressed.
	63	By default, closes and deletes the frame or dialog, then deletes the view.
	64
	65	\membersection{wxPropertyFormView::OnHelp}\label{wxpropertyformviewonhelp}
	66
	67	\func{void}{OnHelp}{\void}
	68
	69	Virtual function that will be called when the Help button on the physical window is pressed.
	70	This needs to be overridden by the application for anything interesting to happen.
	71
	72	\membersection{wxPropertyFormView::OnRevert}\label{wxpropertyformviewonrevert}
	73
	74	\func{void}{OnRevert}{\void}
	75
	76	Virtual function that will be called when the Revert button on the physical window is pressed.
	77	By default transfers the wxProperty values to the panel items (in effect
	78	undoing any unsaved changes in the items).
	79
	80	\membersection{wxPropertyFormView::OnUpdate}\label{wxpropertyformviewonupdate}
	81
	82	\func{void}{OnUpdate}{\void}
	83
	84	Virtual function that will be called when the Update button on the physical window is pressed.
	85	By defaults transfers the displayed values to the wxProperty objects.
	86
	87	\membersection{wxPropertyFormView::SetManagedWindow}\label{wxpropertyformviewsetmanagedwindow}
	88
	89	\func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
	90
	91	Sets the managed window (a frame or dialog) associated with the view.
	92
	93	\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}
	94
fa482912	95	\func{bool}{TransferToDialog}{\void}
200fed6c VS	96
	97	Transfers property values to the controls in the dialog.
	98
	99	\membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet}
	100
fa482912	101	\func{bool}{TransferToPropertySheet}{\void}
200fed6c VS	102
	103	Transfers property values from the controls in the dialog to the property sheet.
	104