Classes
class	sptk::DirectoryDS
	Directory datasource. More...

class	sptk::CBox

class	sptk::CBaseButton

class	sptk::CButton

class	sptk::CSmallButton

class	sptk::CButtonGroup

class	sptk::CCalendar
	Calendar widget. More...

class	sptk::CPopupCalendar
	Popup Calendar. More...

class	sptk::CCheckButton
	The check button. More...

class	sptk::CCheckButtons
	A set of check buttons. More...

class	sptk::CColorSchema
	Stores and restores the color schema. More...

class	sptk::CColumn
	Class CColumn represents a column descriptor for CListView. More...

class	sptk::CColumnList

class	sptk::CBaseListBox
	Base list box widget. More...

class	sptk::CComboBox
	Combo box widget. More...

class	sptk::CListBox
	List Box widget. More...

class	sptk::CControl
	Base class for most of SPTK widgets. More...

class	sptk::CControlList
	List of CControl object pointers in Fl_Group. More...

class	sptk::CDateControl
	Date input widget. More...

class	sptk::CDateIntervalInput
	Date interval input widget. More...

class	sptk::CDateTimeBaseInput
	Base date and time input widget. More...

class	sptk::CDateInput
	Date input widget. More...

class	sptk::CTimeInput
	Time input widget. More...

class	sptk::CDateTimeInput
	Date and time input widget. More...

class	sptk::CDBListView
	List view widget with extended database support. More...

class	sptk::CDialogTabs

class	sptk::CDialog

class	sptk::CDirOpenDialog
	Select Directory Window. More...

class	sptk::CDBDropDownListView
	Drop-down list view. More...

class	sptk::CDBDropDownList
	Drop-down window with CListView widget inside. More...

class	sptk::CEditor
	Text editor widget. More...

class	sptk::CSpellOption

class	sptk::CSpellOptions

class	sptk::CSpellChecker

class	sptk::CEditorSpellChecker

class	sptk::CEventInfo

class	sptk::CFileDialog
	Base class for CFileOpenDialog and CFileSaveDialog. More...

class	sptk::CFileOpenDialog
	File Open Window. More...

class	sptk::CFileSaveDialog
	File Save Window. More...

class	sptk::CFloatInput
	Floating point value input widget. More...

class	sptk::CFont
	Font information. More...

class	sptk::CFontsMap
	CFontsMap is a map font names to fonts. More...

class	sptk::CFontsVector
	CFontsVector is a map font names to fonts. More...

class	sptk::CFontComboBox
	Font combobox widget. More...

class	sptk::CFrame
	Frame information class. More...

class	sptk::CFrames
	Frame images collection. More...

class	sptk::CGroup
	SPTK group widget. More...

class	sptk::CHtmlBox
	Simple HTML viewer. More...

class	sptk::CIcon
	Class CIcon provides a storage of PNG image. More...

class	sptk::CIconMap
	A map of theme icon names to theme icons. More...

class	sptk::CInput_

class	sptk::CInput

class	sptk::CIntegerInput
	Integer value input widget. More...

class	sptk::CLayoutClient

class	sptk::CLayoutManager
	Layout Manager. More...

class	sptk::CListView
	List view widget. More...

class	sptk::CListViewRows

class	sptk::CSelection
	List view & friend items selection. More...

class	sptk::CMemoInput

class	sptk::CMenuBar
	Menu bar. More...

class	sptk::CAskDialog
	A Yes/No dialog box. More...

class	sptk::CMessageDialog
	An information dialog box. More...

class	sptk::CInputDialog
	A single input Yes/No dialog box. More...

class	sptk::CPasswordInput
	Password input widget. More...

class	sptk::CPhoneNumberInput

class	sptk::CPopupWindow
	Base popup window. More...

class	sptk::CProgressBar

class	sptk::CRadioButtons
	Radio buttons widget. More...

class	sptk::CRect

class	sptk::CScroll
	Scroll area widget. More...

class	sptk::CScrollBar

class	sptk::CShapePoint
	A point to define a shape. More...

class	sptk::CSplitter
	Splitter widget. More...

class	sptk::CTabImage
	An image representing one of three required images for theme tabs. More...

class	sptk::CTabImages

class	sptk::CTabs
	Tabs widget. More...

class	sptk::CThemeColorCollection

class	sptk::CThemeImageCollection
	A collection of theme images. More...

class	sptk::CThemes
	Widget themes. More...

class	sptk::CScrollBarImages
	The complete set of four images to draw a scroll bar. More...

class	sptk::CThemeScrollBar

class	sptk::CToolBar
	Toolbar widget. More...

class	sptk::CTreeItem
	Tree widget item. More...

class	sptk::CTreeControl
	Tree widget. More...

class	sptk::CTreeView
	Tree view widget. More...

class	sptk::CWindow
	Window widget. More...

class	sptk::CWindowShape
	Window non-rectangular shape support. More...

class	sptk::MemoryDS
	Base (memory) datasource. More...

class	sptk::ImapDS
	IMAP datasource. More...

class	sptk::CPackedStrings
	Packed strings list. More...

Macros
#define	MAX_BUTTON_IMAGES 5

#define	CLV_SELECTED 1
	List view item is selected.

#define	CLV_CHECKED 2
	List view item is checked.

#define	CLV_NOTDISPLAYED 4
	List view item is hidden.

#define	THM_MAX_COLOR_INDEX 4

#define	THM_MAX_COLOR_STATE 5

#define	THMF_NORMAL 0

#define	THMF_ACTIVE 1

#define	THMF_HIGHLIGHTED 2

#define	MAX_IMAGE_STATES 5

#define	MAX_BACKGROUND_IMAGES 7

Typedefs
using	sptk::CStringControlMap = std::map< std::string, CControl *, CaseInsensitiveCompare >
	String to Control map. Uses strings and pointers to CControl. Strings are control field names.

using	sptk::createControlCallback = CLayoutClient ()(const xdoc::SNode &node)
	A callback that creates a control of the required type. More...

using	sptk::createControlCallbackMap = std::map< std::string, createControlCallback >
	A callback map that stores type names and control create functions.

using	sptk::CWidgetNamesMap = std::map< std::string, Fl_Widget * >
	a map of widget names to widgets

using	sptk::COORD = int16_t
	Coordinate type for shapes.

using	sptk::gtk_color_function = Fl_Color(*)(const String &expression)

using	sptk::CTreeItemCreator = CLayoutClient ()(CTreeItem *item)
	A callback that allows to create a widget of required type and use it as an item body. More...

using	sptk::CTreeItemVector = std::vector< CTreeItem * >
	Vector of CTreeItem pointers.

using	sptk::ProgressCallback = std::function< void(int total, int progress)>

using	sptk::pchar = char *

using	sptk::cpchar = const char *

Enumerations
enum class	sptk::CSmallPixmapType : uint8_t { CSmallPixmapType::SXPM_EXECUTABLE , CSmallPixmapType::SXPM_FOLDER , CSmallPixmapType::SXPM_FOLDER_OPENED , CSmallPixmapType::SXPM_DOCUMENT , CSmallPixmapType::SXPM_TXT_DOCUMENT , CSmallPixmapType::SXPM_XLS_DOCUMENT , CSmallPixmapType::SXPM_DOC_DOCUMENT }

enum class	sptk::CButtonKind : uint32_t { CButtonKind::UNDEFINED_BUTTON = 0 , CButtonKind::OK_BUTTON = 1 , CButtonKind::CANCEL_BUTTON = 2 , CButtonKind::NO_BUTTON = 4 , CButtonKind::ADD_BUTTON = 8 , CButtonKind::DELETE_BUTTON = 0x10 , CButtonKind::EDIT_BUTTON = 0x20 , CButtonKind::BROWSE_BUTTON = 0x40 , CButtonKind::REFRESH_BUTTON = 0x80 , CButtonKind::CALENDAR_BUTTON = 0x100 , CButtonKind::OPEN_BUTTON = 0x200 , CButtonKind::PRINT_BUTTON = 0x400 , CButtonKind::SAVE_BUTTON = 0x800 , CButtonKind::SAVE_AS_BUTTON = 0x1000 , CButtonKind::COPY_BUTTON = 0x2000 , CButtonKind::LEFT_BUTTON = 0x4000 , CButtonKind::NEW_BUTTON = 0x8000 , CButtonKind::NEXT_BUTTON = 0x10000 , CButtonKind::PRINTER_BUTTON = 0x20000 , CButtonKind::PRIOR_BUTTON = 0x40000 , CButtonKind::RIGHT_BUTTON = 0x80000 , CButtonKind::SEARCH_BUTTON = 0x100000 , CButtonKind::SEND_BUTTON = 0x200000 , CButtonKind::STEPLEFT_BUTTON = 0x400000 , CButtonKind::STEPRIGHT_BUTTON = 0x800000 , CButtonKind::VIEW_BUTTON = 0x1000000 , CButtonKind::HOME_BUTTON = 0x2000000 , CButtonKind::CONFIGURE_BUTTON = 0x4000000 , CButtonKind::EXEC_BUTTON = 0x8000000 , CButtonKind::STOP_BUTTON = 0x10000000 , CButtonKind::EXIT_BUTTON = 0x20000000 , CButtonKind::HELP_BUTTON = 0x40000000 , CButtonKind::MAX_BUTTON = 0x40000001 }

enum class	sptk::CControlKind : uint32_t { CControlKind::UNKNOWN = 0 , CControlKind::BOX = 1 , CControlKind::HTMLBOX = 2 , CControlKind::STRING = 4 , CControlKind::MEMO = 8 , CControlKind::INTEGER = 0x10 , CControlKind::FLOAT = 0x20 , CControlKind::DATE = 0x40 , CControlKind::TIME = 0x80 , CControlKind::DATETIME = 0x100 , CControlKind::DATEINTERVAL = 0x200 , CControlKind::COMBO = 0x400 , CControlKind::INTVALUECOMBO = 0x800 , CControlKind::LISTBOX = 0x1000 , CControlKind::CHECKBUTTONS = 0x2000 , CControlKind::RADIOBUTTONS = 0x4000 , CControlKind::PHONE = 0x8000 , CControlKind::TREEVIEW = 0x10000 , CControlKind::GROUP = 0x20000 , CControlKind::SLIDER = 0x40000 , CControlKind::PROGRESS = 0x80000 }
	Control kind is the constant to report the internal SPTK RTTI. More...

enum class	sptk::InputEntryFlags : uint32_t { InputEntryFlags::NONE = 0 , InputEntryFlags::SPELLCHECK = 1 , InputEntryFlags::MANDATORY = 2 , InputEntryFlags::CFIELD = 4 , InputEntryFlags::SINGLELINEENTRY = 256 , InputEntryFlags::MULTILINEENTRY = 512 }
	Special control flags (used as bit combination) More...

enum class	sptk::CDialogModalResult : uint8_t { CDialogModalResult::NONE , CDialogModalResult::OK , CDialogModalResult::CANCEL , CDialogModalResult::USER }

enum class	sptk::CEvent : uint8_t { CEvent::NONE , CEvent::DATA_CHANGED , CEvent::FOCUS , CEvent::UNFOCUS , CEvent::SHOW , CEvent::HIDE , CEvent::KEYBOARD , CEvent::MOUSE_CLICK , CEvent::MOUSE_DOUBLE_CLICK , CEvent::MOUSE_DRAG , CEvent::MOUSE_MOVE , CEvent::MOUSE_RELEASE , CEvent::MOUSE_WHEEL , CEvent::PROGRESS , CEvent::BUTTON_PRESSED , CEvent::ADD_ITEM , CEvent::EDIT_ITEM , CEvent::DELETE_ITEM , CEvent::REFRESH , CEvent::LAST_EVENT }

enum class	sptk::CIconSize : uint8_t { CIconSize::IS_COMBO_ICON , CIconSize::IS_SMALL_ICON , CIconSize::IS_LARGE_ICON , CIconSize::IS_DIALOG_ICON }
	Icon size variations. More...

enum class	sptk::CLayoutAlign : uint8_t { NONE , CLayoutAlign::LEFT , CLayoutAlign::RIGHT , CLayoutAlign::TOP , CLayoutAlign::BOTTOM , CLayoutAlign::CLIENT }

enum class	sptk::CLayoutXMLmode : uint8_t { CLayoutXMLmode::DATA = 1 , CLayoutXMLmode::LAYOUT = 2 , CLayoutXMLmode::LAYOUTDATA = 3 }

enum class	sptk::CLayoutGrowMode : uint8_t { CLayoutGrowMode::LGM_NONE = 0 , CLayoutGrowMode::LGM_HORIZONTAL_GROW = 1 , CLayoutGrowMode::LGM_VERTICAL_GROW = 2 , CLayoutGrowMode::LGM_AUTO_GROW = 3 }
	Layout manager grow mode. More...

enum class	sptk::CRefreshKind : uint8_t { CRefreshKind::LV_REFRESH_FULL , CRefreshKind::LV_REFRESH_FAST }
	The refersh kind. More...

enum class	sptk::CListViewDataMode : uint8_t { CListViewDataMode::LV_DATA_UNDEFINED , CListViewDataMode::LV_DATA_KEY , CListViewDataMode::LV_DATA_INDEX , CListViewDataMode::LV_DATA_CAPTION }
	The data mode for the data() methods. More...

enum	sptk::CScrollbarMode { HORIZONTAL = 1 , VERTICAL = 2 , BOTH = 3 , ALWAYS_ON = 4 , HORIZONTAL_ALWAYS = 5 , VERTICAL_ALWAYS = 6 , BOTH_ALWAYS = 7 }
	Different modes for scrollbars.

enum	sptk::CTabImageIndex { TI_INACTIVE = 0 , TI_ACTIVE = 1 , TI_BORDER = 2 }
	Typee of the tab image.

enum	sptk::CThemeColorIndex { sptk::THM_FOREGROUND_COLOR , sptk::THM_BACKGROUND_COLOR , sptk::THM_BASE_COLOR , sptk::THM_TEXT_COLOR }

enum	sptk::CThemeColorState { sptk::THM_COLOR_UNDEFINED = -1 , sptk::THM_COLOR_NORMAL = 0 , sptk::THM_COLOR_PRELIGHT = 1 , sptk::THM_COLOR_SELECTED = 2 , sptk::THM_COLOR_ACTIVE = 3 , sptk::THM_COLOR_INSENSITIVE = 4 }

enum	sptk::CThemeImageState { THM_IMAGE_NORMAL = THMF_NORMAL , THM_IMAGE_ACTIVE = THMF_ACTIVE , THM_IMAGE_NORMAL_HIGHLITED = THMF_NORMAL \| THMF_HIGHLIGHTED , THM_IMAGE_ACTIVE_HIGHLITED = THMF_ACTIVE \| THMF_HIGHLIGHTED , THM_DEFAULT_FRAME = ((THMF_ACTIVE \| THMF_HIGHLIGHTED) + 1) }
	Theme button type - defines which routine to use for which FLTK button type.

enum	sptk::CThemeButtonType { THM_BUTTON_COMBO , THM_BUTTON_CHECK , THM_BUTTON_RADIO , THM_BUTTON_NORMAL }
	Theme button size - defines the button size and look to select the correct pixmap.

enum	sptk::CThemeScrollBarType { THM_SCROLLBAR_VERTICAL , THM_SCROLLBAR_HORIZONTAL }
	Theme scroll bar type - defines the scroll bar direction.

Functions
SP_EXPORT bool	sptk::checkFieldName (const String &fldName)
	Internal field name validation.

CControl *	sptk::createControl (CControlKind controlKind, const String &label, const String &fieldName, int layoutSize)
	Creates a single control. More...

void	sptk::createControls (const xdoc::SNode &xmlControls)
	Create a control or a group of controls. More...

SP_EXPORT int	sptk::spAsk (const String &message)
	A Yes/No dialog box function. More...

SP_EXPORT int	sptk::spWarning (const String &message)
	A warning information dialog box warning function. More...

SP_EXPORT int	sptk::spError (const String &message)
	An error information dialog box function. More...

int SP_EXPORT	sptk::spInformation (const String &message)
	An information dialog box function. More...

int SP_EXPORT	sptk::spInput (const String &message, String &inputText)
	A single input Yes/No dialog box. More...

Variables
const Strings	sptk::smallPixmapIDs
	A list of predefined icon names used by ListView, primarily.

constexpr int	sptk::SINGLE_EDIT_ENTRY_HEIGHT = 23
	Default height for the single-row edit control.

Detailed Description

Typedef Documentation

◆ cpchar

using sptk::cpchar = typedef const char*

Type definition for cpchar

◆ createControlCallback

using sptk::createControlCallback = typedef CLayoutClient* (*) (const xdoc::SNode& node)

A callback that creates a control of the required type.

The information (layout,style,etc) is provided by the XML node

◆ CTreeItemCreator

using sptk::CTreeItemCreator = typedef CLayoutClient* (*) (CTreeItem* item)

A callback that allows to create a widget of required type and use it as an item body.

An item body should be any CLayoutClient-derived widget. By default (if that callback isn't redefined, SPTK creates CBox widget.

Parameters

item	CTreeItem*, a tree item that would be a parent for the new item

◆ pchar

using sptk::pchar = typedef char*

Type definition for pchar

◆ ProgressCallback

using sptk::ProgressCallback = typedef std::function<void(int total, int progress)>

Progression callback function prototype

Enumeration Type Documentation

◆ CButtonKind

enum class sptk::CButtonKind : uint32_t

strong

Button widget kind

The button kind defines a picture and a default label for the button.

Enumerator
UNDEFINED_BUTTON	Default button without image, or with user-defined image.
OK_BUTTON	'Ok' button
CANCEL_BUTTON	'Cancel' button
NO_BUTTON	'No' button
ADD_BUTTON	'Add' button
DELETE_BUTTON	'Delete' button
EDIT_BUTTON	'Edit' button
BROWSE_BUTTON	'Browse' button
REFRESH_BUTTON	'Refresh' button
CALENDAR_BUTTON	'Calendar' button
OPEN_BUTTON	'Open' button
PRINT_BUTTON	'Print' button
SAVE_BUTTON	'Save' button
SAVE_AS_BUTTON	'Save As' button
COPY_BUTTON	'Copy' button
LEFT_BUTTON	'Left' button
NEW_BUTTON	'New' button
NEXT_BUTTON	'Next' button
PRINTER_BUTTON	'Printer' button
PRIOR_BUTTON	'Prior' button
RIGHT_BUTTON	'Right' button
SEARCH_BUTTON	'Left' button
SEND_BUTTON	'Send' button
STEPLEFT_BUTTON	'Step Left' button
STEPRIGHT_BUTTON	'Step Right' button
VIEW_BUTTON	'View' button
HOME_BUTTON	'Home' button
CONFIGURE_BUTTON	'Configure' button
EXEC_BUTTON	Execute' button.
STOP_BUTTON	'Stop' button
EXIT_BUTTON	'Exit' button
HELP_BUTTON	'Help' button
MAX_BUTTON	Max button id.

◆ CControlKind

enum class sptk::CControlKind : uint32_t

strong

Control kind is the constant to report the internal SPTK RTTI.

Enumerator
UNKNOWN	Control kind is unknown
BOX	Control is a box of plain text
HTMLBOX	Control is a box of HTML text
STRING	Control is a text input (single line)
MEMO	Control is a text input (multiple lines)
INTEGER	Control is an integer value input
FLOAT	Control is an integer value input
DATE	Control is a date input
TIME	Control is a time input
DATETIME	Control is a date and time input
DATEINTERVAL	Control is a date interval input
COMBO	Control is a combobox
INTVALUECOMBO	Control is a combobox with int key value
LISTBOX	Control is a listbox
CHECKBUTTONS	Control is a set of check buttons
RADIOBUTTONS	Control is a set of radio buttons
PHONE	Control is a phone number input
TREEVIEW	Control is a tree widget
GROUP	Control is a group
SLIDER	Control is a value slider
PROGRESS	Control is a progress bar

◆ CDialogModalResult

enum class sptk::CDialogModalResult : uint8_t

strong

The closing dialog result value.

You can check it after the dialog exits the modal state, using modalResult() method. If the Ok button was pressed, it would return DMR_OK. For Cancel button it would return DMR_CANCEL. And, for user buttons, it would be DMR_USER.

Enumerator
NONE	Modal result undefined
OK	Ok button pressed
CANCEL	Cancel button pressed
USER	User-added button pressed

◆ CEvent

enum class sptk::CEvent : uint8_t

strong

Event type constants

Enumerator
NONE	Empty event (no event)
DATA_CHANGED	Control data changed
FOCUS	Control received focus
UNFOCUS	Control lost focus
SHOW	Control visibility changed to show
HIDE	Control visibility changed to hide
KEYBOARD	Keyboard event in control
MOUSE_CLICK	Mouse clicked on control
MOUSE_DOUBLE_CLICK	Mouse double-clicked on control
MOUSE_DRAG	Mouse dragged on control
MOUSE_MOVE	Mouse moved over control
MOUSE_RELEASE	Mouse released over control
MOUSE_WHEEL	Mouse wheel over control
PROGRESS	Progress event (if control supports it)
BUTTON_PRESSED	Keyboard button pressed
ADD_ITEM	List event - item added (if control supports it)
EDIT_ITEM	List event - item edited or changed (if control supports it)
DELETE_ITEM	List event - item deleted (if control supports it)
REFRESH	List event - list refreshed (if control supports it)
LAST_EVENT	Last event number (no event)

◆ CIconSize

enum class sptk::CIconSize : uint8_t

strong

Icon size variations.

Enumerator
IS_COMBO_ICON	Combo box icon, 12x12
IS_SMALL_ICON	Small button icon, 16x16
IS_LARGE_ICON	Large button icon, 22x22
IS_DIALOG_ICON	Dialog icon, 48x48

◆ CLayoutAlign

enum class sptk::CLayoutAlign : uint8_t

strong

Possible values for the widget layout aligns

Enumerator
LEFT	Do not use allignment.
RIGHT	Align to the left.
TOP	Align to the right.
BOTTOM	Align to the top.
CLIENT	Align to the bottom. Use the whole available space

◆ CLayoutGrowMode

enum class sptk::CLayoutGrowMode : uint8_t

strong

Layout manager grow mode.

Allows or disables the layout to grow in horizontal and/or vertical direction

Enumerator
LGM_NONE	Don't allow layout to grow
LGM_HORIZONTAL_GROW	Allow horizontal grow only
LGM_VERTICAL_GROW	Allow vertical grow only
LGM_AUTO_GROW	Allow both horizontal and vertical grow

◆ CLayoutXMLmode

enum class sptk::CLayoutXMLmode : uint8_t

strong

Layout load and save mode

Enumerator
DATA	Load and save only controls data
LAYOUT	Load and save only controls layout
LAYOUTDATA	Load and save controls data and layout

◆ CListViewDataMode

enum class sptk::CListViewDataMode : uint8_t

strong

The data mode for the data() methods.

Enumerator
LV_DATA_UNDEFINED	data() sets/returns item caption. If the data connection is defined (in CDBListView) - it flips to LV_DATA_KEY mode.
LV_DATA_KEY	data() sets/returns item key value
LV_DATA_INDEX	data() sets/returns item index
LV_DATA_CAPTION	data() sets/returns item caption

◆ CRefreshKind

enum class sptk::CRefreshKind : uint8_t

strong

The refersh kind.

Enumerator
LV_REFRESH_FULL	Retrieve the full dataset and replace the existing records completely
LV_REFRESH_FAST	Retrieve only the changed records and replace the changed records only

◆ CSmallPixmapType

enum class sptk::CSmallPixmapType : uint8_t

strong

A list of predefined small pixmaps

Enumerator
SXPM_EXECUTABLE	Small pixmap - executable
SXPM_FOLDER	Small pixmap - folder
SXPM_FOLDER_OPENED	Small pixmap - opened folder
SXPM_DOCUMENT	Small pixmap - document
SXPM_TXT_DOCUMENT	Small pixmap - text document
SXPM_XLS_DOCUMENT	Small pixmap - Excel document
SXPM_DOC_DOCUMENT	Small pixmap - Word document

◆ CThemeColorIndex

enum sptk::CThemeColorIndex

Theme color constants enumeration

Enumerator
THM_FOREGROUND_COLOR	Foreground color index
THM_BACKGROUND_COLOR	Background color index
THM_BASE_COLOR	Base color index
THM_TEXT_COLOR	Text color index

◆ CThemeColorState

enum sptk::CThemeColorState

Theme color states enumeration

Enumerator
THM_COLOR_UNDEFINED	Color is undefined
THM_COLOR_NORMAL	Normal color
THM_COLOR_PRELIGHT	Prelight color
THM_COLOR_SELECTED	Selection color
THM_COLOR_ACTIVE	Active (focused) color
THM_COLOR_INSENSITIVE	Intensive color

◆ InputEntryFlags

enum class sptk::InputEntryFlags : uint32_t

strong

Special control flags (used as bit combination)

Enumerator
NONE	No flags
SPELLCHECK	Requires spell checking
MANDATORY	Must have some value
CFIELD	Is a custom field
SINGLELINEENTRY	Is a single-line entry
MULTILINEENTRY	Is a multi-line entry

Function Documentation

◆ createControl()

CControl * sptk::createControl	(	CControlKind	controlKind,
		const String &	label,
		const String &	fieldName,
		int	layoutSize
	)

Creates a single control.

The utility function that allows to create a control with one step

Parameters

controlKind	int, a control kind
label	std::string, a control label
fieldName	std::string, a control field name
layoutSize	int, a control layout size

◆ createControls()

void sptk::createControls ( const xdoc::SNode & xmlControls )

Create a control or a group of controls.

Every XML node in xmlControls should be CONTROL node and may contain the following elements: type a control type, one of the { AREA CODE, CURRENCY, CREDIT CARD, COMBO, CHOICE, CHECK BUTTONS, DATE, DATE AND TIME, FLOAT, GROUP, HTML, INTEGER, LABEL, LONG ZIP CODE, MASK, MULTIPLE CHOICE, MONEY, PHONE, PHONE EXT, PLAIN TEXT, PHONE NUMBER, PHONE EXTENSION, SIMPLE, STRING, SSN, TIME, ZIP CODE } label a label, optional fieldName a field name, optional values a list of values separated with '|' for list-based controls, string, optional sqlValues an SQL query to build the list values, string, optional, presented as a sub-node with CDATA visible visibility flag, optional, true or false (1/0) enable enable flage, optional, true or false (1/0) align layout align, optional, one of { top,bottom,left,right,client}, the default is top size layout size in pixels, optional

The group node may contain other controls. If the control type or parameter is not recognized, the exception is thrown.

Parameters

xmlControls The controls description in XML

◆ spAsk()

SP_EXPORT int sptk::spAsk ( const String & message )

A Yes/No dialog box function.

Creates a dialog with the text or HTML text of question (message) and two buttons (Ok/Cancel)

◆ spError()

SP_EXPORT int sptk::spError ( const String & message )

An error information dialog box function.

Creates a dialog with the text or HTML text of message and one button (Ok)

◆ spInformation()

int SP_EXPORT sptk::spInformation ( const String & message )

An information dialog box function.

Creates a dialog with the text or HTML text of message and one button (Ok)

◆ spInput()

int SP_EXPORT sptk::spInput	(	const String &	message,
		String &	inputText
	)

A single input Yes/No dialog box.

Creates a dialog with the text or HTML text of question (message), two buttons (Ok/Cancel), and input box

◆ spWarning()

SP_EXPORT int sptk::spWarning ( const String & message )

A warning information dialog box warning function.

Creates a dialog with the text or HTML text of message and one button (Ok)

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ cpchar

◆ createControlCallback

◆ CTreeItemCreator

◆ pchar

◆ ProgressCallback

Enumeration Type Documentation

◆ CButtonKind

◆ CControlKind

◆ CDialogModalResult

◆ CEvent

◆ CIconSize

◆ CLayoutAlign

◆ CLayoutGrowMode

◆ CLayoutXMLmode

◆ CListViewDataMode

◆ CRefreshKind

◆ CSmallPixmapType

◆ CThemeColorIndex

◆ CThemeColorState

◆ InputEntryFlags

Function Documentation

◆ createControl()

◆ createControls()

◆ spAsk()

◆ spError()

◆ spInformation()

◆ spInput()

◆ spWarning()