Files
l7/L7/LBoundComboBox.h
SET aaacf88071 Added classes to manage simple tabular data of known structure using a
popup containing a wxGrid object.

BasePicker : Abstract class adding a popup to wxPickerBase  styled with
a wxTextCtrl.
BaseGridPicker : Abstract class adding a wxGrid in the popup.

JsonGridPickerCtrl : UI control storing the tabular data in a JSON
array.
LBoundJsonGridPicker : connect JsonGridPicker to database.
LGridJsonCellEditor : use LBoundJsonGridPicker in other wxGrid objects.
LGridJsonCellRenderer : render cell JSON data.

XmlGridPickerCtrl : UI control storing the tabular data in as XML
document.
LBoundXmlGridPicker : connect XmlGridPicker to database.
LGridXmlCellEditor : grid editor for LBoundXmlGridPicker.
LGridXmlCellRenderer : grid renderer for LBoundXmlGridPicker.

JsonHelper and XmlHelper : for applications to quickly get intent value
from database data..

The structure of managed tabular data :

Column 1 : Intent - this is what we want to store/edit. This can be
telephone numbers, email addresses, instant messaging addresses...
any single line piece of information that can exist many times for one
entity (person, company...).
Column 2 : Type - A short description of the intent : 'Home, Work,
Mobile, Fax, Other...'. It is displayed in a non editable wxComboBox.
Column 3 : Preferred - One line of data can be selected as the preferred
one. It is not mandatory, but it must be a single choice.
Column 4 : Notes - single line notes.

Adjust sql scripts and L7.dox.
Applied ANSI formatting style to all files.

Other changes :

Work around a nasty misbehavior.
Grid columns edited by a translated combobox expect full string
data as cell values. LResultSet::BEData() will report these mapped strings,
instead of database real data. LBoundComboBox::IsDirty() will always be
true even if the editor is unchanged once created.
Simplest workaround : disconnect m_BoundComboBox if unchanged.

LGridTextEditor::ProvideFormEditor() : set the form editor's value
explicitely.; wxTextCtrl does not interpret data it receives

LBoundControl::SetNull must be void.

LBoundGrid : Unbind:: instructions should limit to the widget's id, like Bind::

LConnection::GetReturnedKeys should return NULL.
LConnection::SetData should return void.

Notes : wxJSON must be configured with the same prefix as wxWidgets,
here /usr/local/{wxWidgets,wxWidgets-Release}.
2019-12-23 08:12:01 +01:00

130 lines
3.8 KiB
C++

/*
* File: LBoundComboBox.h
* Author: SET - nmset@netcourrier.com
* License : LGPL version 2.1
* Copyright SET, M. D. - © 2014
*
* Created on 3 juin 2014, 19:00
*/
#ifndef LBOUNDCOMBOBOX_H
#define LBOUNDCOMBOBOX_H
#include <wx/combobox.h>
#include "LBoundControl.h"
#include "LResultSet.h"
/**
* The control is called 'translated' if its items have associated client data that are instances of LItemData.
* The item strings are then only descriptive.
*/
class LBoundComboBox : public wxComboBox, public LBoundControl
{
public:
LBoundComboBox(wxWindow* parent, wxWindowID id = wxID_ANY);
virtual ~LBoundComboBox();
/**
*
* @return true if any of the items is associated with an instance of LItemData
*/
bool IsTranslated() const;
bool SelectionIsTranslated() const;
/**
* If the control is not translated, returns the string item at idx.
*
* Else, returns the associated data of the item at idx, or wxEmptyString.
* @param idx
* @return
*/
const wxAny GetDataOfIndex(unsigned int idx) const;
/**
* If the control is not translated, calls FindString(idx).
*
* Else, returns the index of the item whose associated data equals the parameter, or wxNOT_FOUND.
* @param data
* @return
*/
const int GetIndexOfData(const wxAny& data) const;
/**
* If the control is not translated, returns wxEmptyString (there is no data associated with any item).
*
* Else, returns the item whose associated data equals the parameter, or wxEmptyString.
* @param data
* @return
*/
const wxString GetItemOfData(const wxAny& data) const;
/**
* If the control is not translated, returns the parameter itself.
*
* Else, returns the associated data of the parameter, or wxEmptyString.
* @param item
* @return
*/
const wxAny GetDataOfItem(const wxString& item) const;
/**
* If the control is not translated, returns wxEmptyString.
*
* Else, returns the first item that does not have an associated data, or wxEmptyString.
* @return
*/
const wxString GetItemOfNull() const;
/**
* If the control is not translated, returns wxNOT_FOUND.
*
* Else, returns the index of the first item that does not have an associated data, or wxNOT_FOUND.
* @return
*/
const int GetIndexOfNull() const;
/**
* Deletes all items, sets selection to wxNOT_FOUND and wxEmptyString.
*/
void Clear();
/**
* If IsNull() is true, returns literal NULL.
*
* If the control is not translated, returns GetValue().
*
* Else, returns the associated client data value of the selection.
* @return
*/
const wxAny GetData();
/**
* If the control is not translated, calls SetValue() and returns FindString().
*
* If newData is empty or literal NULL, calls SetNull().
* Else, selects the first item whose associated client data equals newData.
* @param newData
*/
void SetData(const wxAny& newData);
/**
* Sets the resultset member and registers the control in the resultset.
* @param newResultSet
*/
void SetResultSet(LResultSet * newResultSet);
/**
* If the control is not translated, returns true if the selected item is empty.
*
* Else, return true if the selected item does not have any associated client data.
* @return
*/
bool IsNull();
/**
* If the control is not translated, sets its value to wxEmptyString with wxNOT_FOUND selection.
*
* Else, selects the first item that does not have an associated client data.
* @return
*/
void SetNull();
bool IsDirty();
/**
* Alias for GetValue().
* @return
*/
const wxString GetDisplayedData();
private:
};
#endif /* LBOUNDCOMBOBOX_H */