A suggestion popup suggesting contacts from an addressbook. More...

#include <ContactSuggestions.h>

Inheritance diagram for ContactSuggestions:

Public Member Functions
	ContactSuggestions ()
	Create a new ContactSuggestions popup. More...

void	setAddressBook (const std::vector< Contact > &contacts)
	Set the address book. More...

Public Member Functions inherited from Wt::WSuggestionPopup
	WSuggestionPopup (const Options &options)

	WSuggestionPopup (const std::string &matcherJS, const std::string &replacerJS)

void	forEdit (WFormWidget *edit, WFlags< PopupTrigger > popupTriggers=PopupTrigger::Editing)

void	removeEdit (WFormWidget *edit)

void	showAt (WFormWidget *edit)

void	clearSuggestions ()

void	addSuggestion (const WString &suggestionText, const WString &suggestionValue=WString::Empty)

void	setModel (const std::shared_ptr< WAbstractItemModel > &model)

std::shared_ptr< WAbstractItemModel >	model () const

void	setModelColumn (int index)

void	setDefaultIndex (int row)

int	defaultIndex () const

void	setFilterLength (int count)

int	filterLength () const

Signal< WString > &	filterModel ()

Signal< int, WFormWidget * > &	activated ()

void	setDropDownIconUnfiltered (bool isUnfiltered)

void	setAutoSelectEnabled (bool enabled)

int	currentItem () const

void	setEditRole (ItemDataRole role)

ItemDataRole	editRole () const

Public Member Functions inherited from Wt::WPopupWidget
	WPopupWidget (std::unique_ptr< WWidget > impl)

virtual	~WPopupWidget ()

void	setAnchorWidget (WWidget *widget, Orientation orientation=Orientation::Vertical)

Orientation	orientation () const

void	setTransient (bool transient, int autoHideDelay=0)

bool	isTransient () const

int	autoHideDelay () const

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override

Signal &	hidden ()

Signal &	shown ()

Public Member Functions inherited from Wt::WCompositeWidget
	WCompositeWidget ()

	WCompositeWidget (std::unique_ptr< WWidget > implementation)

virtual std::vector< WWidget * >	children () const override

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override

virtual void	setObjectName (const std::string &name) override

virtual std::string	objectName () const override

virtual const std::string	id () const override

virtual void	setPositionScheme (PositionScheme scheme) override

virtual PositionScheme	positionScheme () const override

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override

virtual WLength	offset (Side s) const override

virtual void	resize (const WLength &width, const WLength &height) override

virtual WLength	width () const override

virtual WLength	height () const override

virtual void	setMinimumSize (const WLength &width, const WLength &height) override

virtual WLength	minimumWidth () const override

virtual WLength	minimumHeight () const override

virtual void	setMaximumSize (const WLength &width, const WLength &height) override

virtual WLength	maximumWidth () const override

virtual WLength	maximumHeight () const override

virtual void	setLineHeight (const WLength &height) override

virtual WLength	lineHeight () const override

virtual void	setFloatSide (Side s) override

virtual Side	floatSide () const override

virtual void	setClearSides (WFlags< Side > sides) override

virtual WFlags< Side >	clearSides () const override

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override

virtual WLength	margin (Side side) const override

virtual void	setHiddenKeepsGeometry (bool enabled) override

virtual bool	hiddenKeepsGeometry () const override

virtual bool	isHidden () const override

virtual bool	isVisible () const override

virtual void	setDisabled (bool disabled) override

virtual bool	isDisabled () const override

virtual bool	isEnabled () const override

virtual void	setPopup (bool popup) override

virtual bool	isPopup () const override

virtual void	setInline (bool isInline) override

virtual bool	isInline () const override

virtual void	setDecorationStyle (const WCssDecorationStyle &style) override

virtual WCssDecorationStyle &	decorationStyle () override

virtual void	setStyleClass (const WString &styleClass) override

virtual WString	styleClass () const override

virtual void	addStyleClass (const WString &styleClass, bool force=false) override

virtual void	removeStyleClass (const WString &styleClass, bool force=false) override

virtual bool	hasStyleClass (const WString &styleClass) const override

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto) override

virtual AlignmentFlag	verticalAlignment () const override

virtual WLength	verticalAlignmentLength () const override

virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override

virtual WString	toolTip () const override

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override

virtual void	refresh () override

virtual void	setAttributeValue (const std::string &name, const WString &value) override

virtual WString	attributeValue (const std::string &name) const override

virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override

virtual std::string	javaScriptMember (const std::string &name) const override

virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override

virtual void	load () override

virtual bool	loaded () const override

virtual void	setCanReceiveFocus (bool enabled) override

virtual bool	canReceiveFocus () const override

virtual void	setFocus (bool focus) override

virtual bool	setFirstFocus () override

virtual bool	hasFocus () const override

virtual void	setTabIndex (int index) override

virtual int	tabIndex () const override

virtual void	setId (const std::string &id) override

virtual WWidget *	find (const std::string &name) override

virtual WWidget *	findById (const std::string &name) override

virtual void	setSelectable (bool selectable) override

virtual void	doJavaScript (const std::string &js) override

virtual void	propagateSetEnabled (bool enabled) override

virtual bool	scrollVisibilityEnabled () const final override

virtual void	setScrollVisibilityEnabled (bool enabled) final override

virtual int	scrollVisibilityMargin () const final override

virtual void	setScrollVisibilityMargin (int margin) final override

virtual Signal< bool > &	scrollVisibilityChanged () final override

virtual bool	isScrollVisible () const final override

virtual void	setThemeStyleEnabled (bool enabled) final override

virtual bool	isThemeStyleEnabled () const final override

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)

std::unique_ptr< Widget >	removeWidget (Widget *widget)

void	setFocus ()

virtual void	setFocus (bool focus)=0

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()

WWidget *	parent () const

std::unique_ptr< Widget >	removeWidget (Widget *widget)

std::unique_ptr< WWidget >	removeFromParent ()

void	setWidth (const WLength &width)

void	setHeight (const WLength &height)

virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)

virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)

std::string	jsRef () const

void	setFocus ()

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())

virtual void	stopAcceptDrops (const std::string &mimeType)

virtual void	htmlText (std::ostream &out)

bool	isRendered () const

void	hide ()

void	animateHide (const WAnimation &animation)

void	show ()

void	animateShow (const WAnimation &animation)

void	enable ()

void	disable ()

bool	layoutSizeAware () const

Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)

Child *	addChild (std::unique_ptr< Child > child)

std::unique_ptr< WObject >	removeChild (WObject *child)

std::unique_ptr< Child >	removeChild (Child *child)

void	resetLearnedSlots ()

void	resetLearnedSlot (void(T::*method)())

WStatelessSlot *	implementStateless (void(T::*method)())

WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())

void	isNotStateless ()

WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)

Public Member Functions inherited from Wt::Core::observable
	observable () noexcept

virtual	~observable ()

auto	bindSafe (void(C::*method)(Args...)) noexcept

auto	bindSafe (void(C::*method)(Args...) const) const noexcept

auto	bindSafe (const Function &function) noexcept

Additional Inherited Members
Public Types inherited from Wt::WSuggestionPopup
typedef PopupTrigger	Trigger

Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()

Static Public Member Functions inherited from Wt::WSuggestionPopup
static std::string	generateMatcherJS (const Options &options)

static std::string	generateReplacerJS (const Options &options)

Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)

Protected Member Functions inherited from Wt::WSuggestionPopup
virtual void	render (WFlags< RenderFlag > flags) override

Protected Member Functions inherited from Wt::WCompositeWidget
virtual void	enableAjax () override

void	setImplementation (std::unique_ptr< WWidget > widget)

Widget *	setImplementation (std::unique_ptr< Widget > widget)

W *	setNewImplementation (Args &&... args)

WWidget *	implementation ()

virtual int	boxPadding (Orientation orientation) const override

virtual int	boxBorder (Orientation orientation) const override

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)

virtual void	layoutSizeChanged (int width, int height)

	WWidget ()

virtual void	dropEvent (WDropEvent dropEvent)

void	scheduleRender (WFlags< RepaintFlag > flags=None)

virtual WStatelessSlot *	getStateless (Method method) override

Detailed Description

A suggestion popup suggesting contacts from an addressbook.

This popup provides suggestions from a list of contact, by matching parts of the name or email adress with the current value being edited. It also supports editing a list of email addresses.

The popup is only available when JavaScript is available, and is implemented entirely on the client-side.

Definition at line 32 of file ContactSuggestions.h.

Constructor & Destructor Documentation

◆ ContactSuggestions()

ContactSuggestions::ContactSuggestions ( )

Create a new ContactSuggestions popup.

Definition at line 26 of file ContactSuggestions.C.

   : WSuggestionPopup(WSuggestionPopup::generateMatcherJS(contactOptions),
                      WSuggestionPopup::generateReplacerJS(contactOptions))
 { }

Member Function Documentation

◆ setAddressBook()

void ContactSuggestions::setAddressBook ( const std::vector< Contact > & contacts )

Set the address book.

Definition at line 31 of file ContactSuggestions.C.

 {
   clearSuggestions();
  
   for(auto contact : contacts)
     addSuggestion(contact.formatted(), contact.formatted());
 }

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

composer/ContactSuggestions.h
composer/ContactSuggestions.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ContactSuggestions()

Member Function Documentation

◆ setAddressBook()