An edit field for an email attachment. More...

#include <AttachmentEdit.h>

Inheritance diagram for AttachmentEdit:

Classes
class	UploadInfo

Public Member Functions
	AttachmentEdit (Composer *composer)
	Creates an attachment edit field.
bool	uploadNow ()
	Updates the file now.
bool	uploadFailed () const
	Returns whether the upload failed.
std::vector< Attachment >	attachments ()
	Returns the attachment.
Signal &	uploadDone ()
	Signal emitted when new attachment(s) have been uploaded (or failed to upload.
Public Member Functions inherited from Wt::WContainerWidget
	WContainerWidget ()
	~WContainerWidget ()
void	setLayout (std::unique_ptr< WLayout > layout)
Layout *	setLayout (std::unique_ptr< Layout > layout)
WLayout *	layout () const
virtual void	addWidget (std::unique_ptr< WWidget > widget)
Widget *	addWidget (std::unique_ptr< Widget > widget)
Widget *	addNew (Args &&...args)
virtual void	insertBefore (std::unique_ptr< WWidget > widget, WWidget *before)
Widget *	insertBefore (std::unique_ptr< Widget > widget, WWidget *before)
virtual void	insertWidget (int index, std::unique_ptr< WWidget > widget)
Widget *	insertWidget (int index, std::unique_ptr< Widget > widget)
Widget *	insertNew (int index, Args &&...args)
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override
virtual void	clear ()
virtual int	indexOf (WWidget *widget) const
virtual WWidget *	widget (int index) const
virtual int	count () const
void	setContentAlignment (WFlags< AlignmentFlag > contentAlignment)
void	setPadding (const WLength &padding, WFlags< Side > sides=AllSides)
WLength	padding (Side side) const
WFlags< AlignmentFlag >	contentAlignment () const
void	setOverflow (Overflow overflow, WFlags< Orientation > orientation=(Orientation::Horizontal\|Orientation::Vertical))
void	setList (bool list, bool ordered=false)
bool	isList () const
bool	isUnorderedList () const
bool	isOrderedList () const
EventSignal< WScrollEvent > &	scrolled ()
int	scrollTop () const
int	scrollLeft () const
std::unique_ptr< Widget >	removeWidget (Widget *widget)
Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget ()
EventSignal< WKeyEvent > &	keyWentDown ()
EventSignal< WKeyEvent > &	keyPressed ()
EventSignal< WKeyEvent > &	keyWentUp ()
EventSignal &	enterPressed ()
EventSignal &	escapePressed ()
EventSignal< WMouseEvent > &	clicked ()
EventSignal< WMouseEvent > &	doubleClicked ()
EventSignal< WMouseEvent > &	mouseWentDown ()
EventSignal< WMouseEvent > &	mouseWentUp ()
EventSignal< WMouseEvent > &	mouseWentOut ()
EventSignal< WMouseEvent > &	mouseWentOver ()
EventSignal< WMouseEvent > &	mouseMoved ()
EventSignal< WMouseEvent > &	mouseDragged ()
EventSignal< WMouseEvent > &	mouseWheel ()
EventSignal< WTouchEvent > &	touchStarted ()
EventSignal< WTouchEvent > &	touchEnded ()
EventSignal< WTouchEvent > &	touchMoved ()
EventSignal< WGestureEvent > &	gestureStarted ()
EventSignal< WGestureEvent > &	gestureChanged ()
EventSignal< WGestureEvent > &	gestureEnded ()
void	setDraggable (const std::string &mimeType, WWidget dragWidget=nullptr, bool isDragWidgetOnly=false, WObject sourceWidget=nullptr)
void	unsetDraggable ()
void	setMouseOverDelay (int delay)
int	mouseOverDelay () const
virtual void	setPopup (bool popup) override
virtual void	load () override
virtual bool	isEnabled () const override
Public Member Functions inherited from Wt::WWebWidget
	WWebWidget ()
virtual std::vector< WWidget * >	children () const override
Signal &	childrenChanged ()
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
void	anchorAt (WWidget *widget, Orientation orientation=Orientation::Vertical) 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 void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
virtual bool	isHidden () const override
virtual bool	isVisible () const override
virtual void	setDisabled (bool disabled) override
virtual bool	isDisabled () const override
virtual bool	isPopup () const override
std::string	positionAnchorName () const override
void	becomePositionAnchor () override
void	setPositionAnchor (const std::string &anchorName) override
void	setPositionAnchor (WWidget *anchor) override
std::string	positionAnchor () 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()) override
virtual AlignmentFlag	verticalAlignment () const override
virtual WLength	verticalAlignmentLength () const override
virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
virtual WString	toolTip () const override
void	showToolTipOnHover (bool enable)
void	showToolTip ()
void	hideToolTip ()
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 bool	loaded () const override
virtual void	setId (const std::string &id) override
virtual WWidget *	find (const std::string &name) override
virtual WWidget *	findById (const std::string &id) override
virtual void	setSelectable (bool selectable) override
virtual void	doJavaScript (const std::string &javascript) override
virtual const std::string	id () const override
void	setLoadLaterWhenInvisible (bool)
std::string	htmlTagName () const
void	setHtmlTagName (const std::string &tag)
bool	resendFormData () override
virtual void	setCanReceiveFocus (bool enabled) override
virtual bool	canReceiveFocus () const override
virtual bool	setFirstFocus () override
virtual void	setFocus (bool focus) override
virtual bool	hasFocus () const override
virtual void	setTabIndex (int index) override
virtual int	tabIndex () const override
EventSignal &	blurred ()
EventSignal &	focussed ()
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 void	setObjectName (const std::string &name) override
void	setFocus ()
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, WFlags< Orientation > adjustOrientations=AllOrientations)
bool	isPositionAnchor () const
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)
virtual void	htmlText (std::ostream &out, WStringStream &js)
bool	isRendered () const
void	hide ()
void	animateHide (const WAnimation &animation)
void	show ()
void	animateShow (const WAnimation &animation)
void	enable ()
void	disable ()
bool	layoutSizeAware () const
virtual void	scheduleThemeStyleApply (std::shared_ptr< Wt::WTheme > theme, WWidget *child, int role)
virtual void	applyThemeStyles ()
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)
virtual std::string	objectName () const
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

Private Member Functions
void	uploaded ()
	Slot triggered when the WFileUpload completed an upload.
void	fileTooLarge (::int64_t size)
	Slot triggered when the WFileUpload received an oversized file.
void	remove ()
	Slot triggered when the users wishes to remove this attachment edit.

Private Attributes
Composer *	composer_
Signal	uploadDone_
WFileUpload *	upload_
	The WFileUpload control.
std::vector< UploadInfo * >	uploadInfo_
WText *	error_
	The text box to display an error (empty or too big file).
Option *	remove_
	The option to cancel the file upload.
bool	uploadFailed_
	The state of the last upload process.

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
Static Public Member Functions inherited from Wt::WWebWidget
static std::string	jsStringLiteral (const std::string &v, char delimiter='\'')
static void	setDefaultNativeControl (bool enabled)
static bool	defaultNativeControl ()
Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
Static Public Attributes inherited from Wt::WInteractWidget
static const std::string	noDefault
Protected Member Functions inherited from Wt::WInteractWidget
void	render (WFlags< RenderFlag > flags) override
virtual void	propagateSetEnabled (bool enabled) override
Protected Member Functions inherited from Wt::WWebWidget
virtual void	enableAjax () override
virtual WStatelessSlot *	getStateless (Method method) 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)
virtual int	boxPadding (Orientation orientation) const
virtual int	boxBorder (Orientation orientation) const
void	scheduleRender (WFlags< RepaintFlag > flags=None)

Detailed Description

An edit field for an email attachment.

This widget manages one attachment edit: it shows a file upload control, handles the upload, and gives feed-back on the file uploaded.

This widget is part of the Wt composer example.

Definition at line 37 of file AttachmentEdit.h.

Constructor & Destructor Documentation

◆ AttachmentEdit()

AttachmentEdit::AttachmentEdit ( Composer * composer )

Creates an attachment edit field.

Definition at line 68 of file AttachmentEdit.C.

  : WContainerWidget(),
    composer_(composer),
    uploadDone_(),
    uploadFailed_(false)
{
  /*
   * The file upload itself.
   */
  upload_ = this->addWidget(std::make_unique<WFileUpload>());
  upload_->setMultiple(true);
  upload_->setFileTextSize(40);
 
  /*
   * A progress bar
   */
  std::unique_ptr<WProgressBar> progress = std::make_unique<WProgressBar>();
  progress->setFormat(WString::Empty);
  progress->setVerticalAlignment(AlignmentFlag::Middle);
  upload_->setProgressBar(std::move(progress));
 
  /*
   * The 'remove' option.
   */
  remove_ = this->addWidget(std::make_unique<Option>(tr("msg.remove")));
  upload_->decorationStyle().font().setSize(FontSize::Smaller);
  upload_->setVerticalAlignment(AlignmentFlag::Middle);
  remove_->setMargin(5, Side::Left);
  remove_->item()->clicked().connect(this, &WWidget::hide);
  remove_->item()->clicked().connect(this, &AttachmentEdit::remove);
 
  // The error message.
  error_ = this->addWidget(std::make_unique<WText>(""));
  error_->setStyleClass("error");
  error_->setMargin(WLength(5), Side::Left);
 
  /*
   * React to events.
   */
 
  // Try to catch the fileupload change signal to trigger an upload.
  // We could do like google and at a delay with a WTimer as well...
  upload_->changed().connect(upload_, &WFileUpload::upload);
 
  // React to a succesfull upload.
  upload_->uploaded().connect(this, &AttachmentEdit::uploaded);
 
  // React to a fileupload problem.
  upload_->fileTooLarge().connect(this, &AttachmentEdit::fileTooLarge);
 
  /*
   * Connect the uploadDone signal to the Composer's attachmentDone,
   * so that the Composer can keep track of attachment upload progress,
   * if it wishes.
   */
  uploadDone_.connect(composer, &Composer::attachmentDone);
}

Member Function Documentation

◆ attachments()

std::vector< Attachment > AttachmentEdit::attachments ( )

Returns the attachment.

Definition at line 189 of file AttachmentEdit.C.

{
  std::vector<Attachment> result;
 
  for (unsigned i = 0; i < uploadInfo_.size(); ++i) {
    if (uploadInfo_[i]->keep_->isChecked()) {
      Http::UploadedFile& f = uploadInfo_[i]->info_;
      f.stealSpoolFile();
      result.push_back(Attachment
                       (WString(f.clientFileName()),
                        WString(f.contentType()),
                        f.spoolFileName()));
    }
  }
 
  return result;
}

◆ fileTooLarge()

void AttachmentEdit::fileTooLarge ( ::int64_t size )

private

Slot triggered when the WFileUpload received an oversized file.

Definition at line 176 of file AttachmentEdit.C.

{
  error_->setText(tr("msg.file-too-large")
                  .arg(size / 1024)
                  .arg(WApplication::instance()->maximumRequestSize() / 1024));
  uploadFailed_ = true;
 
  /*
   * Signal to the Composer that a new asyncrhonous file upload was processed.
   */
  uploadDone_.emit();
}

◆ remove()

void AttachmentEdit::remove ( )

private

Slot triggered when the users wishes to remove this attachment edit.

Definition at line 171 of file AttachmentEdit.C.

{
  composer_->removeAttachment(this);
}

◆ uploadDone()

Signal & AttachmentEdit::uploadDone ( )

inline

Signal emitted when new attachment(s) have been uploaded (or failed to upload.

Definition at line 63 of file AttachmentEdit.h.

63{ return uploadDone_; }

◆ uploaded()

void AttachmentEdit::uploaded ( )

private

Slot triggered when the WFileUpload completed an upload.

Definition at line 142 of file AttachmentEdit.C.

{
  std::vector<Http::UploadedFile> files = upload_->uploadedFiles();
 
  if (!files.empty()) {
    /*
     * Delete this widgets since we have a succesfull upload.
     */
    upload_ = 0;
    this->removeWidget(remove_);
    remove_ = 0;
    this->removeWidget(error_);
    error_ = 0;
 
    for (unsigned i = 0; i < files.size(); ++i) {
      UploadInfo *info = this->addWidget(std::make_unique<UploadInfo>(files[i]));
      uploadInfo_.push_back(info);
    }
  } else {
    error_->setText(tr("msg.file-empty"));
    uploadFailed_ = true;
  }
 
  /*
   * Signal to the Composer that a new asynchronous file upload was processed.
   */
  uploadDone_.emit();
}

◆ uploadFailed()

bool AttachmentEdit::uploadFailed ( ) const

inline

Returns whether the upload failed.

Definition at line 54 of file AttachmentEdit.h.

54{ return uploadFailed_; }

◆ uploadNow()

bool AttachmentEdit::uploadNow ( )

Updates the file now.

Returns whether a new file will be uploaded. If so, the uploadDone signal will be signalled when the file is uploaded (or failed to upload).

Definition at line 126 of file AttachmentEdit.C.

{
  /*
   * See if this attachment still needs to be uploaded,
   * and return if a new asynchronous upload is started.
   */
  if (upload_) {
    if (upload_->canUpload()) {
      upload_->upload();
      return true;
    } else
      return false;
  } else
    return false;
}

Member Data Documentation

◆ composer_

Composer* AttachmentEdit::composer_

private

Definition at line 66 of file AttachmentEdit.h.

◆ error_

WText* AttachmentEdit::error_

private

The text box to display an error (empty or too big file).

Definition at line 90 of file AttachmentEdit.h.

◆ remove_

Option* AttachmentEdit::remove_

private

The option to cancel the file upload.

Definition at line 93 of file AttachmentEdit.h.

◆ upload_

WFileUpload* AttachmentEdit::upload_

private

The WFileUpload control.

Definition at line 71 of file AttachmentEdit.h.

◆ uploadDone_

Signal AttachmentEdit::uploadDone_

private

Definition at line 68 of file AttachmentEdit.h.

◆ uploadFailed_

bool AttachmentEdit::uploadFailed_

private

The state of the last upload process.

Definition at line 96 of file AttachmentEdit.h.

◆ uploadInfo_

std::vector<UploadInfo *> AttachmentEdit::uploadInfo_

private

Definition at line 87 of file AttachmentEdit.h.

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

composer/AttachmentEdit.h
composer/AttachmentEdit.C

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AttachmentEdit()

Member Function Documentation

◆ attachments()

◆ fileTooLarge()

◆ remove()

◆ uploadDone()

◆ uploaded()

◆ uploadFailed()

◆ uploadNow()

Member Data Documentation

◆ composer_

◆ error_

◆ remove_

◆ upload_

◆ uploadDone_

◆ uploadFailed_

◆ uploadInfo_