initial commit

Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>

libs/wxWidgets-3.3.1/interface/wx/valgen.h

@@ -0,0 +1,162 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        valgen.h
+// Purpose:     interface of wxGenericValidator
+// Author:      wxWidgets team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxGenericValidator
+
+    wxGenericValidator performs data transfer (but not validation or filtering)
+    for many type of controls.
+
+    wxGenericValidator supports:
+    - wxButton, wxRadioButton, wxToggleButton, wxBitmapToggleButton, wxSpinButton
+    - wxCheckBox, wxRadioBox, wxComboBox, wxListBox, wxCheckListBox
+    - wxGauge, wxSlider, wxScrollBar, wxChoice, wxStaticText
+    - wxSpinCtrl, wxTextCtrl, wxColourPickerCtrl (since wxWidgets 3.3.0 or later).
+
+    It checks the type of the window and uses an appropriate type for it.
+    For example, wxButton and wxTextCtrl transfer data to and from a
+    wxString variable; wxListBox uses a wxArrayInt; wxCheckBox uses a boolean.
+
+    @since 3.2.5
+    A wxLB_SINGLE wxListBox can also use an int.  wxColourPickerCtrl support.
+    A 3-state wxCheckBox can use wxCheckBoxState.
+
+    @since 3.3.0
+    A group of wxRadioButton controls can also be associated with an int.
+
+    For more information, please see @ref overview_validator.
+
+    @library{wxcore}
+    @category{validator}
+
+    @see @ref overview_validator, wxValidator, wxTextValidator,
+        wxIntegerValidator, wxFloatingPointValidator
+*/
+class wxGenericValidator : public wxValidator
+{
+public:
+    /**
+        Copy constructor.
+
+        @param validator
+            Validator to copy.
+    */
+    wxGenericValidator(const wxGenericValidator& validator);
+    /**
+        Constructor taking a bool pointer. This will be used for wxCheckBox,
+        wxRadioButton, wxToggleButton and wxBitmapToggleButton.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */
+    wxGenericValidator(bool* valPtr);
+    /**
+        Constructor taking a wxString pointer. This will be used for wxButton,
+        wxComboBox, wxStaticText, wxTextCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */
+    wxGenericValidator(wxString* valPtr);
+    /**
+        Constructor taking an integer pointer. This will be used for wxChoice,
+        wxGauge, wxScrollBar, wxRadioBox, wxSlider, wxSpinButton and
+        wxSpinCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */
+    wxGenericValidator(int* valPtr);
+    /**
+        Constructor taking a wxArrayInt pointer. This will be used for
+        wxListBox, wxCheckListBox, and groups of wxRadioButton.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */
+    wxGenericValidator(wxArrayInt* valPtr);
+    /**
+        Constructor taking a wxDateTime pointer. This will be used for
+        wxDatePickerCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+    */
+    wxGenericValidator(wxDateTime* valPtr);
+    /**
+        Constructor taking a wxFileName pointer. This will be used for
+        wxTextCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+        @since 2.9.3
+    */
+    wxGenericValidator(wxFileName* valPtr);
+    /**
+        Constructor taking a float pointer. This will be used for
+        wxTextCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+        @since 2.9.3
+    */
+    wxGenericValidator(float* valPtr);
+    /**
+        Constructor taking a double pointer. This will be used for
+        wxTextCtrl.
+
+        @param valPtr
+            A pointer to a variable that contains the value. This variable
+            should have a lifetime equal to or longer than the validator
+            lifetime (which is usually determined by the lifetime of the
+            window).
+        @since 2.9.3
+    */
+    wxGenericValidator(double* valPtr);
+
+    /**
+        Destructor.
+    */
+    virtual ~wxGenericValidator();
+
+    /**
+        Clones the generic validator using the copy constructor.
+    */
+    virtual wxObject* Clone() const;
+
+    /**
+        Transfers the value from the window to the appropriate data type.
+    */
+    virtual bool TransferFromWindow();
+
+    /**
+        Transfers the value to the window.
+    */
+    virtual bool TransferToWindow();
+};
+