docs/latex/wx/propview.tex

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