Molybden API
Loading...
Searching...
No Matches
molybden::EditorCommand Struct Reference

Public Member Functions

 EditorCommand (const std::string &name, const std::string &value="")
 

Static Public Member Functions

static EditorCommand bold ()
 Returns a command that allows making the selected text bold in a WYSIWYG editor.
 
static EditorCommand copy ()
 Returns a command that allows copying the selected text in the frame.
 
static EditorCommand cut ()
 Returns a command that allows cutting the selected text in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteSelectedText ()
 Returns a command that allows deleting the selected text in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteBackward ()
 Returns a command that allows deleting character before the caret position in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteForward ()
 Returns a command that allows deleting character after the caret position in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteToBeginningOfLine ()
 Returns a command that allows deleting character from the caret position to the beginning of line in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteWordBackward ()
 Returns a command that allows deleting a word before the caret position in a text field, text area or WYSIWYG editor.
 
static EditorCommand deleteWordForward ()
 Returns a command that allows deleting a word after the caret position in a text field, text area or WYSIWYG editor.
 
static EditorCommand insertNewLine ()
 Returns a command that allows inserting a new line in a WYSIWYG editor.
 
static EditorCommand insertParagraph ()
 Returns a command that allows inserting a paragraph in a WYSIWYG editor.
 
static EditorCommand insertTab ()
 Returns a command that allows inserting a tab character in a WYSIWYG editor.
 
static EditorCommand ignoreSpelling ()
 Returns a command that allows disabling the spelling mistakes highlighting in a text area or a WYSIWYG editor.
 
static EditorCommand italic ()
 Returns a command that allows making the selected text italic in a WYSIWYG editor.
 
static EditorCommand movePageUp ()
 Returns a command that allows moving the caret position at one page up in a text area or a WYSIWYG editor.
 
static EditorCommand movePageDown ()
 Returns a command that allows moving the caret position at one page down in a text area or a WYSIWYG editor.
 
static EditorCommand moveWordLeft ()
 Returns a command that allows moving a word left in a text area or a WYSIWYG editor.
 
static EditorCommand moveWordLeftAndModifySelection ()
 Returns a command that allows moving a word left and modifying selection in a text area or a WYSIWYG editor.
 
static EditorCommand moveWordRight ()
 Returns a command that allows moving a word right in a text area or a WYSIWYG editor.
 
static EditorCommand moveWordRightAndModifySelection ()
 Returns a command that allows moving a word right and modifying selection in a text area or a WYSIWYG editor.
 
static EditorCommand moveToBeginningOfLine ()
 Returns a command that allows moving a word to the beginning of line in a text area or a WYSIWYG editor.
 
static EditorCommand moveToBeginningOfLineAndModifySelection ()
 Returns a command that allows moving a word to the beginning of line and modifying selection in a text area or a WYSIWYG editor.
 
static EditorCommand moveToEndOfLine ()
 Returns a command that allows moving a word to the end of line in a text area or a WYSIWYG editor.
 
static EditorCommand moveToEndOfLineAndModifySelection ()
 Returns a command that allows moving a word to the end of line and modifying selection in a text area or a WYSIWYG editor.
 
static EditorCommand paste ()
 Returns a command that allows pasting content of the clipboard in a text field, text area or a WYSIWYG editor.
 
static EditorCommand redo ()
 Returns a command that allows reversing the last undo() action.
 
static EditorCommand scrollPageBackward ()
 Returns a command that allows scrolling a page backward.
 
static EditorCommand scrollPageForward ()
 Returns a command that allows scrolling a page forward.
 
static EditorCommand scrollLineUp ()
 Returns a command that allows scrolling one line up.
 
static EditorCommand scrollLineDown ()
 Returns a command that allows scrolling one line down.
 
static EditorCommand scrollToBeginningOfDocument ()
 Returns a command that allows scrolling content to the beginning of the document in the frame.
 
static EditorCommand scrollToEndOfDocument ()
 Returns a command that allows scrolling content to the end of the document in the frame.
 
static EditorCommand selectAll ()
 Returns a command that allows selecting all text in the frame or the currently focused text field, text area or a WYSIWYG editor.
 
static EditorCommand selectLine ()
 Returns a command that allows selecting a line at the caret position in a text area or a WYSIWYG editor.
 
static EditorCommand selectParagraph ()
 Returns a command that allows selecting the whole paragraph at the caret position in a text area or a WYSIWYG editor.
 
static EditorCommand selectSentence ()
 Returns a command that allows selecting the whole sentence at the caret position in a text area or a WYSIWYG editor.
 
static EditorCommand selectWord ()
 Returns a command that allows selecting the word at the caret position in a text field, text area or a WYSIWYG editor.
 
static EditorCommand toggleBold ()
 Returns a command that allows toggling bold style for the selected text in a WYSIWYG editor.
 
static EditorCommand toggleItalic ()
 Returns a command that allows toggling italic style for the selected text in a WYSIWYG editor.
 
static EditorCommand toggleUnderline ()
 Returns a command that allows toggling underline style for the selected text in a WYSIWYG editor.
 
static EditorCommand underline ()
 Returns a command that allows underlying the selected text in a WYSIWYG editor.
 
static EditorCommand undo ()
 Returns a command that allows reversing the last action.
 
static EditorCommand unselect ()
 Returns a command that allows clearing the current selection in a frame.
 
static EditorCommand strikethrough ()
 Returns a command that allows making the selected text strikethrough in a WYSIWYG editor.
 
static EditorCommand superscript ()
 Returns a command that allows making the selected text superscript in a WYSIWYG editor.
 
static EditorCommand subscript ()
 Returns a command that allows making the selected text subscript in a WYSIWYG editor.
 
static EditorCommand removeFormat ()
 Returns a command that allows removing all styles of the selected text (bold, italic, etc.) in a WYSIWYG editor.
 
static EditorCommand unlink ()
 Returns a command that allows removing the link from the text in a WYSIWYG editor.
 
static EditorCommand justifyCenter ()
 Returns a command that allows center justification the selected text in a WYSIWYG editor.
 
static EditorCommand justifyFull ()
 Returns a command that allows full justification the selected text in a WYSIWYG editor.
 
static EditorCommand justifyLeft ()
 Returns a command that allows full justification the selected text in a WYSIWYG editor.
 
static EditorCommand justifyRight ()
 Returns a command that allows right justification the selected text in a WYSIWYG editor.
 
static EditorCommand indent ()
 Returns a command that allows making indent of the selected text in a WYSIWYG editor.
 
static EditorCommand outdent ()
 Returns a command that allows making outdent of the selected text in a WYSIWYG editor.
 
static EditorCommand insertOrderedList ()
 Returns a command that allows inserting an ordered list in a WYSIWYG editor.
 
static EditorCommand insertUnorderedList ()
 Returns a command that allows inserting an unordered list in a WYSIWYG editor.
 
static EditorCommand backgroundColor (const Color &color)
 Returns a command that allows setting the given background color for the selected text in a WYSIWYG editor.
 
static EditorCommand backgroundColor (const std::string &color_name)
 Returns a command that allows setting the given background color_name for the selected text in a WYSIWYG editor.
 
static EditorCommand findText (const std::string &text)
 Returns a command that allows searching for the given text occurrence from the current caret position in the frame.
 
static EditorCommand fontSize (AbsoluteFontSize font_size)
 Returns a command that allows setting the given font_size for the selected text in a WYSIWYG editor.
 
static EditorCommand fontName (const std::string &font_name)
 Returns a command that allows setting the given fontName for the selected text in a WYSIWYG editor.
 
static EditorCommand foregroundColor (const Color &color)
 Returns a command that allows setting the given foreground color for the selected text in a WYSIWYG editor.
 
static EditorCommand foregroundColor (const std::string &color_name)
 Returns a command that allows setting the given foreground color_name for the selected text in a WYSIWYG editor.
 
static EditorCommand insertImage (const std::string &image_src)
 Returns a command that allows inserting an image with the given image_src in a WYSIWYG editor.
 
static EditorCommand insertHtml (const std::string &html)
 Returns a command that allows inserting the given html content in a WYSIWYG editor.
 
static EditorCommand insertText (const std::string &text)
 Returns a command that allows inserting the given text content in a WYSIWYG editor or a text field.
 
static EditorCommand createLink (const std::string &url)
 Returns a command that allows making the link to the specified URL in a WYSIWYG editor.
 

Public Attributes

std::string name
 The name of the command.
 
std::string value
 A string that represents the command value.
 

Member Function Documentation

◆ backgroundColor() [1/2]

static EditorCommand molybden::EditorCommand::backgroundColor ( const Color color)
static

Returns a command that allows setting the given background color for the selected text in a WYSIWYG editor.

Parameters
colora new background color.

◆ backgroundColor() [2/2]

static EditorCommand molybden::EditorCommand::backgroundColor ( const std::string &  color_name)
static

Returns a command that allows setting the given background color_name for the selected text in a WYSIWYG editor.

Parameters
color_namea new background color name.

◆ createLink()

static EditorCommand molybden::EditorCommand::createLink ( const std::string &  url)
static

Returns a command that allows making the link to the specified URL in a WYSIWYG editor.

Parameters
urlthe value of the href attribute of the A tag.

◆ findText()

static EditorCommand molybden::EditorCommand::findText ( const std::string &  text)
static

Returns a command that allows searching for the given text occurrence from the current caret position in the frame.

If match found, this command will select it and scroll down to make it visible, if needed.

Parameters
texta text to search.

◆ fontName()

static EditorCommand molybden::EditorCommand::fontName ( const std::string &  font_name)
static

Returns a command that allows setting the given fontName for the selected text in a WYSIWYG editor.

Parameters
font_namea new font name.

◆ fontSize()

static EditorCommand molybden::EditorCommand::fontSize ( AbsoluteFontSize  font_size)
static

Returns a command that allows setting the given font_size for the selected text in a WYSIWYG editor.

Parameters
font_sizea new font size.

◆ foregroundColor() [1/2]

static EditorCommand molybden::EditorCommand::foregroundColor ( const Color color)
static

Returns a command that allows setting the given foreground color for the selected text in a WYSIWYG editor.

Parameters
colora new foreground color.

◆ foregroundColor() [2/2]

static EditorCommand molybden::EditorCommand::foregroundColor ( const std::string &  color_name)
static

Returns a command that allows setting the given foreground color_name for the selected text in a WYSIWYG editor.

Parameters
color_namea new foreground color name.

◆ insertHtml()

static EditorCommand molybden::EditorCommand::insertHtml ( const std::string &  html)
static

Returns a command that allows inserting the given html content in a WYSIWYG editor.

Parameters
htmlan html content to insert.

◆ insertImage()

static EditorCommand molybden::EditorCommand::insertImage ( const std::string &  image_src)
static

Returns a command that allows inserting an image with the given image_src in a WYSIWYG editor.

If the image_src points to an invalid location, then image won't be inserted.

Parameters
image_srcthe value of the src attribute of the IMG tag.

◆ insertText()

static EditorCommand molybden::EditorCommand::insertText ( const std::string &  text)
static

Returns a command that allows inserting the given text content in a WYSIWYG editor or a text field.

Parameters
texta text content to insert.

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