docs/latex/wx/proplstv.tex

   1 \section{\class{wxPropertyListView}}\label{wxpropertylistview}
   2
   3 \overview{wxPropertyListView overview}{wxpropertylistviewoverview}
   4
   5 The {\bf wxPropertyListView} class shows a wxPropertySheet as a Visual Basic-style property list.
   6
   7 \membersection{wxPropertyListView::wxPropertyListView}
   8
   9 \func{void}{wxPropertyListView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
  10
  11 Constructor.
  12
  13 The {\it flags} argument can be a bit list of the following:
  14
  15 \begin{itemize}\itemsep=0pt
  16 \item wxPROP\_BUTTON\_CLOSE
  17 \item wxPROP\_BUTTON\_OK
  18 \item wxPROP\_BUTTON\_CANCEL
  19 \item wxPROP\_BUTTON\_CHECK\_CROSS
  20 \item wxPROP\_BUTTON\_HELP
  21 \item wxPROP\_DYNAMIC\_VALUE\_FIELD
  22 \item wxPROP\_PULLDOWN
  23 \end{itemize}
  24
  25 \membersection{wxPropertyListView::\destruct{wxPropertyListView}}
  26
  27 \func{void}{\destruct{wxPropertyListView}}{\void}
  28
  29 Destructor.
  30
  31 \membersection{wxPropertyListView::AssociatePanel}\label{wxpropertylistviewassociatepanel}
  32
  33 \func{void}{AssociatePanel}{\param{wxPanel *}{panel}}
  34
  35 Associates the window on which the controls will be displayed, with the view (sets an internal pointer to the window).
  36
  37 \membersection{wxPropertyListView::BeginShowingProperty}\label{wxpropertylistviewbeginshowingproperty}
  38
  39 \func{Bool}{BeginShowingProperty}{\param{wxProperty *}{property}}
  40
  41 Finds the appropriate validator and loads the property into the controls, by calling
  42 wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty.
  43
  44 \membersection{wxPropertyListView::DisplayProperty}\label{wxpropertylistviewdisplayproperty}
  45
  46 \func{Bool}{DisplayProperty}{\param{wxProperty *}{property}}
  47
  48 Calls wxPropertyValidator::OnDisplayValue for the current property's validator. This function
  49 gets called by wxPropertyListView::BeginShowingProperty, which is in turn called
  50 from ShowProperty, called by OnPropertySelect, called by the listbox callback when selected.
  51
  52 \membersection{wxPropertyListView::EndShowingProperty}\label{wxpropertylistviewendshowingproperty}
  53
  54 \func{Bool}{EndShowingProperty}{\param{wxProperty *}{property}}
  55
  56 Finds the appropriate validator and unloads the property from the controls, by calling
  57 wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in
  58 detailed editing mdoe) wxPropertyValidator::OnClearDetailControls.
  59
  60 \membersection{wxPropertyListView::GetPanel}\label{wxpropertylistviewgetpanel}
  61
  62 \func{wxPanel *}{GetPanel}{\void}
  63
  64 Returns the panel associated with the view.
  65
  66 \membersection{wxPropertyListView::GetManagedWindow}\label{wxpropertylistviewgetmanagedwindow}
  67
  68 \func{wxWindow *}{GetManagedWindow}{\void}
  69
  70 Returns the managed window (a frame or dialog) associated with the view.
  71
  72 \membersection{wxPropertyListView::GetWindowCancelButton}\label{wxpropertylistviewgetwindowcancelbutton}
  73
  74 \func{wxButton *}{GetWindowCancelButton}{\void}
  75
  76 Returns the window cancel button, if any.
  77
  78 \membersection{wxPropertyListView::GetWindowCloseButton}\label{wxpropertylistviewgetwindowclosebutton}
  79
  80 \func{wxButton *}{GetWindowCloseButton}{\void}
  81
  82 Returns the window close or OK button, if any.
  83
  84 \membersection{wxPropertyListView::GetWindowHelpButton}\label{wxpropertylistviewgetwindowhelpbutton}
  85
  86 \func{wxButton *}{GetWindowHelpButton}{\void}
  87
  88 Returns the window help button, if any.
  89
  90 \membersection{wxPropertyListView::SetManagedWindow}\label{wxpropertylistviewsetmanagedwindow}
  91
  92 \func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
  93
  94 Sets the managed window (a frame or dialog) associated with the view.
  95
  96 \membersection{wxPropertyListView::UpdatePropertyDisplayInList}\label{wxpropertylistviewupdatepropdisplay}
  97
  98 \func{Bool}{UpdatePropertyDisplayInList}{\param{wxProperty *}{property}}
  99
 100 Updates the display for the given changed property.
 101
 102 \membersection{wxPropertyListView::UpdatePropertyList}\label{wxpropertylistviewupdateproplist}
 103
 104 \func{Bool}{UpdatePropertyList}{\param{Bool }{clearEditArea = TRUE}}
 105
 106 Updates the whole property list display.
 107
 108