/usr/include/Wt/WTextEdit is in libwt-dev 3.3.3+dfsg-4.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WTEXTEDIT_H_
#define WTEXTEDIT_H_
#include <Wt/WTextArea>
#include <Wt/WJavaScript>
#include <boost/any.hpp>
namespace Wt {
/*! \class WTextEdit Wt/WTextEdit Wt/WTextEdit
* \brief A rich-text XHTML editor.
*
* The editor provides interactive editing of XHTML text. By default
* it provides basic mark-up (font, formatting, color, links, and
* lists), but additional buttons may be added to the tool bars that
* add additional formatting options.
*
* The implementation is based on <a
* href="http://tinymce.moxiecode.com/">TinyMCE</a>. The widget may be
* configured and tailored using the setConfigurationSetting() and
* related methods that provide direct access to the underlying
* TinyMCE component.
*
* \if cpp
* You can use this widget with TinyMCE version 3 or 4, but this requires
* different configurations.
*
* By default, %Wt assumes a 3.x version of TinyMCE. You need to
* download TinyMCE (version 3.5b1 or later) and deploy the
* <tt>tinymce/jscripts/tiny_mce</tt> folder to
* <i>tinyMCEBaseURL</i>. The default value for <i>tinyMCEBaseURL</i>
* is <i>resourcesURL</i><tt>/tiny_mce</tt>, where <i>resourcesURL</i>
* is the configuration property that locates the %Wt
* <tt>resources/</tt> folder (i.e., we assume by default that you
* copy the <tt>tiny_mce</tt> folder to the <tt>resources/</tt>
* folder), see also \ref deployment "deployment and resources".
*
* If you prefer to use TinyMCE 4 (or later) instead, you'll need to
* set the <i>tinyMCEVersion</i> property to 4 (or later). Note that
* TinyMCE changed its folder layout in version 4. You will need to
* deploy the <tt>js/tinymce</tt> folder to <i>tinyMCEBaseURL</i>. The
* default value for <i>tinyMCEBaseURL</i> for TinyMCE 4 (or later) is
* is <i>resourcesURL</i><tt>/tinymce</tt> (i.e., we assume by default that you
* copy the <tt>tiny_mce</tt> folder to the <tt>resources/</tt>
* folder). If name of main TinyMCE JavaScript file is non-default
* (e.g., CDN <tt>//tinymce.cachefly.net/4.0/tinymce.min.js</tt> or
* <tt>//cdnjs.cloudflare.com/ajax/libs/tinymce/3.5.8/tiny_mce.js</tt>)
* it should be specified via <i>tinyMCEURL</i>.
*
* Because the default folder names are different ("tiny_mce" for
* version 3 versus "tinymce" for version 4, you can have the
* resources for TinyMCE3 and TinyMCE4 alongside each other while
* experimenting with the old and new TinyMCE).
*
* The default location for the TinyMCE resources may be overridden by
* configuring the <i>tinyMCEBaseURL</i> property in your %Wt
* configuration file, see \ref config_general "configuration properties".
*
* \endif
*
* \if java
* You can use this widget with TinyMCE version 3 or version 4.
*
* The choice is global and set using
* {@link Configuration#setTinyMCEVersion(int)}.
* \endif
*
* \if cpp
* Usage example:
* \code
* Wt::WContainerWidget *w = new Wt::WContainerWidget();
* Wt::WLabel *label = new Wt::WLabel("Comments:", w);
* Wt::WTextEdit *edit = new Wt::WTextEdit("", w);
* label->setBuddy(edit);
* \endcode
* \endif
*
* <h3>CSS</h3>
*
* Styling through CSS is not applicable.
*
* \image html WTextEdit-1.png "Default configuration of a WTextEdit"
*/
class WT_API WTextEdit : public WTextArea
{
public:
/*! \brief Creates a new text editor.
*/
WTextEdit(WContainerWidget *parent = 0);
/*! \brief Creates a new text editor and initialize with given text.
*
* The \p text should be valid XHTML.
*/
WTextEdit(const WT_USTRING& text, WContainerWidget *parent = 0);
/*! \brief Destructor.
*/
~WTextEdit();
/*! \brief Returns the TinyMCE version.
*
* This returns the configured version of TinyMCE (currently 3 or 4).
*/
int version() const { return version_; }
/*! \brief Sets the content.
*
* The \p text should be valid XHTML.
*
* The default value is "".
*/
virtual void setText(const WT_USTRING& text);
/*! \brief Sets the stylesheet for displaying the content.
*
* The content is rendered using the rules defined in this
* stylesheet. The stylesheet is also used to derive additional
* styles that are available in the text editor, for example in the
* "styleselect" button.
*
* Multiple stylesheets may be specified as a comma separated list.
*/
void setStyleSheet(const std::string& uri);
/*! \brief Returns the content stylesheet.
*
* \sa setStyleSheet()
*/
const std::string styleSheet() const;
/*! \brief Loads additional TinyMCE plugins.
*
* %Wt loads by default only the plugin 'safari' (which adds support
* for the Safari web browser). Use this method to load additional
* plugins. Multiple plugins may be specified as a comma separated
* list.
*
* The various plugins are described in the <a
* href="http://www.tinymce.com/wiki.php/Plugins">TinyMCE
* documentation</a>.
*
* \note Plugins can only be loaded before the initial display of
* the widget.
*/
void setExtraPlugins(const std::string& plugins);
/*! \brief Returns the extra plugins.
*
* \sa setExtraPlugins()
*/
const std::string extraPlugins() const;
/*! \brief Configures a tool bar.
*
* This configures the buttons for the \p i'th tool bar (with 0
* <= \p i <= 3).
*
* <h3>TinyMCE 3</h3>
* The syntax and available buttons is documented in the <a
* href="http://www.tinymce.com/wiki.php/Configuration3x:theme_advanced_buttons_1_n">TinyMCE
* documentation</a>.
*
* The default <i>config</i> for the first tool bar (\p i = 0)
is: "fontselect, |, bold, italic, underline, |, fontsizeselect, |,
forecolor, backcolor, |, justifyleft, justifycenter, justifyright,
justifyfull, |, anchor, |, numlist, bullist".
*
* By default, the other three tool bars are disabled (\p config = "").
*
* <h3>TinyMCE 4</h3>
*
* The syntax and available buttons is documented in the <a
* href="http://www.tinymce.com/wiki.php/Configuration:toolbar%3CN%3E">
* TinyMCEdocumentation</a>.
*
* The default <i>config</i> for the first tool bar (\p i = 0)
is: "undo redo | styleselect | bold italic | link".
*
* Some buttons are only available after loading extra plugins using
* setExtraPlugins().
*
* \note The tool bar configuration can only be set before the
* initial display of the widget.
*/
void setToolBar(int i, const std::string& config);
/*! \brief Returns a tool bar configuration.
*
* \sa setToolBar()
*/
const std::string toolBar(int i) const;
/*! \brief Configure a TinyMCE setting.
*
* A list of possible settings can be found at:
* http://tinymce.moxiecode.com/wiki.php/Configuration
*
* The widget itself will also define a number of configuration settings
* and these may be overridden using this method.
*/
void setConfigurationSetting(const std::string& name,
const boost::any& value);
/*! \brief Returns a TinyMCE configuration setting's value.
*
* An empty boost::any is returned when no value could be found for the
* provided argument.
*/
boost::any configurationSetting(const std::string& name) const;
/*! \brief Sets the placeholder text.
*
* This method is not supported on WTextEdit and will thrown an exception
* instead.
*/
virtual void setPlaceholderText(const WString& placeholder);
virtual void setReadOnly(bool readOnly);
virtual void propagateSetEnabled(bool enabled);
virtual void resize(const WLength& width, const WLength& height);
protected:
virtual std::string renderRemoveJs();
virtual void updateDom(DomElement& element, bool all);
virtual void getDomChanges(std::vector<DomElement *>& result,
WApplication *app);
virtual bool domCanBeSaved() const;
virtual int boxPadding(Orientation orientation) const;
virtual int boxBorder(Orientation orientation) const;
private:
JSignal<> onChange_;
int version_;
bool contentChanged_;
std::map<std::string, boost::any> configurationSettings_;
std::string plugins() const;
void init();
void propagateOnChange();
static void initTinyMCE();
static int getTinyMCEVersion();
};
}
#endif // WTEXTEDIT_H_
|