SavvyUI C++ UI Library
Loading...
Searching...
No Matches
GridView Class Reference

A complex component combining a grid and form view with CRUD capabilities. More...

#include <GridView.h>

Inheritance diagram for GridView:
Component ActionListener RowDoubleClickListener

Public Member Functions

 GridView ()
virtual ~GridView ()
void clear ()
 Clears all data and resets the grid and form views.
void enableInlineEditing (BOOL bEnable)
 Enables or disables inline editing mode.
void addColumn (const wstring &name, const wstring &title, BOOL isVisible, UINT width, long alignment=-1, BOOL isSortable=FALSE, BOOL isFilterable=FALSE, BOOL isEditable=FALSE, const EditType &editStyle=EditType::TEXTFIELD, const vector< wstring > &editOptions={})
 Adds a column to the grid.
long addRow ()
 Adds a new empty row to the grid.
void setCellValue (long rowIndex, long columnIndex, const wstring &value)
 Sets the value of a specific cell in the grid.
wstring getCellValue (long rowIndex, long columnIndex)
 Gets the value of a specific cell in the grid.
void setListener (GridViewListener *listener)
 Sets the listener for GridView CRUD events.
void onWindowResized ()
 Called when the window is resized; adjusts layouts.
void onPaint (Graphics *g)
 Called to paint the GridView component.
void onAction (const ActionEvent &ev)
 Handles actions triggered by buttons or other components.
void onItemDoubleClicked (const RowDoubleClickEvent &ev)
 Handles double-click events on grid rows.
Public Member Functions inherited from Component
 Component ()
 Constructs a new Component instance.
virtual ~Component ()
 Virtual destructor.
long getId ()
 Gets the unique ID assigned to this component.
void setParent (Component *parent)
ComponentgetParent ()
wstring getComponentType ()
 Gets the component type string.
BOOL isWindowCreated ()
 Returns whether the native window has been created.
WinHandle getWindowHandle ()
 Returns the native WinHandle for this component.
int createComponent (WinHandle hParent, Bounds rect, long nCmd=-1, BOOL isVisible=TRUE)
 Creates the component's native window as a child of hParent.
void setFont (long fontSize, BOOL isBold=FALSE, BOOL isItalic=FALSE, BOOL isUnderlined=FALSE, const wstring &fontName=L"Arial")
 Sets the font for the component.
void showBorder (BOOL bShow=TRUE)
void setEnabled (BOOL bEnable=TRUE)
 Enables or disables the component.
void setVisible (BOOL bShow=TRUE)
 Shows or hides the component.
void GetClientRect (Bounds &rect)
void GetWindowRect (Bounds &rect)
void moveWindow (long x, long y, long width, long height, BOOL bRedraw=TRUE)
 Moves and resizes the component window.
void reconfigureScrollBar ()
 Forces the component to recalculate the scrollbar info.
void setMouseWheelDelta (int delta)
 Sets the accumulated mouse wheel delta.
int getMouseWheelDelta ()
 Gets the current mouse wheel delta.
virtual int getMinimumHeight ()
 Returns the minimum height the component can have.
virtual int getPreferredHeight ()
 Returns the preferred height of the component.
void repaint (WinHandle hWnd=NULL)
 Requests the component to repaint itself.
void clearQueuedPaintRequest ()
 clears the queued paint request. This function should only be called internally from the library.
virtual void onWindowMoved ()
 Called when the component's window is moved.
virtual void onAction (WinHandle hTarget, long actionId, const ProcParams &procParams)
 Called when an action occurs on the component.
virtual void onSelectionChanged (WinHandle hTarget, int itemIndex, const wstring &itemText, BOOL itemChecked, const ProcParams &procParams)
 Called when the selection changes.
virtual void onDataChanged (WinHandle hTarget, const wstring &newValue, const ProcParams &procParams)
 Called when data changes in the component.
virtual BOOL onHorzScroll (WinHandle hTarget, const ProcParams &procParams)
 Called on horizontal scroll events.
virtual BOOL onDrawMeasureItem (LPMEASUREITEMSTRUCT dis, const ProcParams &procParams)
 Called when measuring an item for owner-draw controls.
virtual BOOL onDrawItem (LPDRAWITEMSTRUCT dis, const ProcParams &procParams)
 Called when drawing an item for owner-draw controls.
virtual void onMousePressed (WinHandle hWnd, int x, int y, int clickCount, BOOL shiftPressed, BOOL ctrlPressed)
 Called when the mouse is pressed within the component.
virtual void onMouseReleased (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
 Called when the mouse button is released within the component.
virtual void onMouseRightClicked (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
 Called when the right mouse button is clicked within the component.
virtual void onMouseMoved (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
 Called when the mouse is moved within the component.
virtual BOOL onMouseWheel (WinHandle hWnd, int x, int y, int delta)
 Called when the mouse wheel is used over the component.
virtual void onArrowLeft (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onArrowRight (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onArrowUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onArrowDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onPageUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onPageDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyHome (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyEnd (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyInsert (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyDelete (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyBackSpace (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyTyped (wchar_t ch, BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyTab (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyEnter (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF1 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF2 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF3 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF4 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF5 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF6 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF7 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF8 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF9 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF10 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF11 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onKeyF12 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void onFocusGained ()
 Called when the component gains keyboard focus.
virtual void onFocusLost ()
 Called when the component loses keyboard focus.
virtual void onTimer (unsigned int timerId)
 Called on timer events.
virtual BOOL getScrollingInfo (__int64 &scrollMin, __int64 &scrollMax, __int64 &pageSize)
 Provides scrolling information if supported.
virtual void setScrollbarTopOffset (__int64 firstVisibleRow)
 Sets the scrollbar's top offset.
void updateScrollbarTopOffset (__int64 firstVisibleRow)
 Updates the scrollbar's top offset based on the current first visible row.

Protected Member Functions

BOOL getCreateWindowOptions (wstring &title, UINT &widownStyles, wstring &wndClassName, BOOL &isCustomWndProc)
 Provides window creation options specific to this component.
void windowCreated ()
 Called after the native window is created; initializes child components.
Protected Member Functions inherited from Component
long getActionId ()
 Returns the component's action command ID.
void doNotSubclass ()
 Marks this component's native window to avoid subclassing.
void startTimer (unsigned int timerId, unsigned int milliseconds)
 Starts a timer with the given ID and interval.
void stopTimer (unsigned int timerId)
 Stops the timer identified by timerId.
void protectedAddDataChangedListener (DataChangeListener *l)
 Adds a data change listener.
void protectedAddSelectionChangedListener (SelectionChangeListener *l)
 Adds a selection change listener.
void protectedAddActionListener (ActionListener *l)
 Adds an action listener.
void protectedAddItemDoubleClickedListener (RowDoubleClickListener *l)
 Adds a row double-click listener.
void protectedFireDataChangedEvent (const wstring &oldValue, const wstring &newValue)
 Fires a data changed event to registered listeners.
void protectedFireSelectionChangedEvent (long selectionIndex=-1, const wstring &selectionValue=L"", BOOL checked=FALSE)
 Fires a selection changed event to registered listeners.
void protectedFireActionEvent (long actionId=-1, const wstring &actionName=L"")
 Fires an action event to registered listeners.
void protectedFireItemDoubleClickedEvent (__int64 rowIndex)
 Fires a row double-click event to registered listeners.

Additional Inherited Members

Protected Attributes inherited from Component
WinHandle _hWnd
 Handle to the native window associated with this component.
wstring _componentType
 String representing the component type (e.g., "Button", "ComboBox").
BOOL _showBorder

Detailed Description

A complex component combining a grid and form view with CRUD capabilities.

The GridView supports both inline editing and form-based editing of grid rows, switching between a grid display and a detailed form view. It also provides buttons for adding, editing, deleting, saving, and canceling changes. Listeners can be registered to react to CRUD events.

Implements ActionListener to handle button actions and RowDoubleClickListener to handle double-click events on grid rows.

Constructor & Destructor Documentation

◆ GridView()

GridView::GridView ( )

◆ ~GridView()

virtual GridView::~GridView ( )
virtual

Member Function Documentation

◆ addColumn()

void GridView::addColumn ( const wstring & name,
const wstring & title,
BOOL isVisible,
UINT width,
long alignment = -1,
BOOL isSortable = FALSE,
BOOL isFilterable = FALSE,
BOOL isEditable = FALSE,
const EditType & editStyle = EditType::TEXTFIELD,
const vector< wstring > & editOptions = {} )

Adds a column to the grid.

Parameters
titleColumn header title.
widthColumn width in pixels.
alignmentText alignment (-1: left, 0: center, 1: right).
editStyleEditing style (e.g., EDIT_TEXTFIELD).
editOptionsOptional list of edit options (for combo boxes etc.).

◆ addRow()

long GridView::addRow ( )

Adds a new empty row to the grid.

Returns
The index of the newly added row.

◆ clear()

void GridView::clear ( )

Clears all data and resets the grid and form views.

◆ enableInlineEditing()

void GridView::enableInlineEditing ( BOOL bEnable)

Enables or disables inline editing mode.

Parameters
bEnableTRUE to enable inline editing, FALSE to disable.

◆ getCellValue()

wstring GridView::getCellValue ( long rowIndex,
long columnIndex )

Gets the value of a specific cell in the grid.

Parameters
rowIndexIndex of the row.
columnIndexIndex of the column.
Returns
The value stored in the cell.

◆ getCreateWindowOptions()

BOOL GridView::getCreateWindowOptions ( wstring & title,
UINT & widownStyles,
wstring & wndClassName,
BOOL & isCustomWndProc )
protectedvirtual

Provides window creation options specific to this component.

Parameters
titleWindow title string (output).
widownStylesWindow style flags (output).
wndClassNameWindow class name string (output).
isCustomWndProcTRUE if a custom window procedure is used (output).
Returns
TRUE if options were successfully provided.

Implements Component.

◆ onAction()

void GridView::onAction ( const ActionEvent & ev)
virtual

Handles actions triggered by buttons or other components.

Parameters
evThe action event describing the source and action.

Implements ActionListener.

◆ onItemDoubleClicked()

void GridView::onItemDoubleClicked ( const RowDoubleClickEvent & ev)
virtual

Handles double-click events on grid rows.

Parameters
evThe double-click event.

Implements RowDoubleClickListener.

◆ onPaint()

void GridView::onPaint ( Graphics * g)
virtual

Called to paint the GridView component.

Parameters
hDCHandle to the device context.

Reimplemented from Component.

◆ onWindowResized()

void GridView::onWindowResized ( )
virtual

Called when the window is resized; adjusts layouts.

Reimplemented from Component.

◆ setCellValue()

void GridView::setCellValue ( long rowIndex,
long columnIndex,
const wstring & value )

Sets the value of a specific cell in the grid.

Parameters
rowIndexIndex of the row.
columnIndexIndex of the column.
valueThe value to set.

◆ setListener()

void GridView::setListener ( GridViewListener * listener)

Sets the listener for GridView CRUD events.

Parameters
listenerPointer to an object implementing GridViewListener.

◆ windowCreated()

void GridView::windowCreated ( )
protectedvirtual

Called after the native window is created; initializes child components.

Implements Component.


The documentation for this class was generated from the following file: