Differential D23725 Diff 65396 modules/ECMAddQtDesignerPlugin.cmake

Changeset View

Standalone View

View Options

modules/ECMAddQtDesignerPlugin.cmake

Show First 20 Lines • Show All 66 Lines • ▼ Show 20 Line(s)
67# ecm_qtdesignerplugin_widget(<widgetid> 67​# ecm_qtdesignerplugin_widget(<widgetid>
68# [CLASS_NAME <class_name>] 68​# [CLASS_NAME <class_name>]
69# [INCLUDE_FILE <include_file>] 69​# [INCLUDE_FILE <include_file>]
70# [CONTAINER] 70​# [CONTAINER]
71# [ICON <iconfile>] 71​# [ICON <iconfile>]
72# [TOOLTIP <tooltip>] 72​# [TOOLTIP <tooltip>]
73# [WHATSTHIS <whatsthis>] 73​# [WHATSTHIS <whatsthis>]
74# [GROUP <group>] 74​# [GROUP <group>]
75# [CREATE_WIDGET_CODE <create_widget_code>] 75​# [CREATE_WIDGET_CODE_FROM_VARIABLE <create_widget_code_variable>]
76# [INITIALIZE_CODE <initialize_code] 76​# [INITIALIZE_CODE_FROM_VARIABLE <initialize_code_variable]
77# [DOM_XML <dom_xml>] 77​# [DOM_XML_FROM_VARIABLE <dom_xml_variable>]
78# [IMPL_CLASS_NAME <impl_class_name>] 78​# [IMPL_CLASS_NAME <impl_class_name>]
79# [CONSTRUCTOR_ARGS_CODE <constructor_args_code>] 79​# [CONSTRUCTOR_ARGS_CODE_FROM_VARIABLE <constructor_args_code_variable>]
80# ) 80​# )
81# 81​#
82# ``CLASS_NAME`` specifies the name of the widget class, including namespaces. 82​# ``CLASS_NAME`` specifies the name of the widget class, including namespaces.
83# The default is "<widgetid>". 83​# The default is "<widgetid>".
84# 84​#
85# ``INCLUDE_FILE`` specifies the include file to use for the class of this 85​# ``INCLUDE_FILE`` specifies the include file to use for the class of this
86# widget. The default is derived from <class_name> as configured by the 86​# widget. The default is derived from <class_name> as configured by the
87# ``DEFAULT_HEADER_*`` options of ``ecm_add_qtdesignerplugin``, also replacing 87​# ``DEFAULT_HEADER_*`` options of ``ecm_add_qtdesignerplugin``, also replacing
Show All 12 Lines
100# 100​#
101# ``WHATSTHIS`` specifies the What's-This text to use for this widget. 101​# ``WHATSTHIS`` specifies the What's-This text to use for this widget.
102# Defaults to the tooltip. 102​# Defaults to the tooltip.
103# 103​#
104# ``GROUP`` specifies the group in Qt Designer where the widget will be placed. 104​# ``GROUP`` specifies the group in Qt Designer where the widget will be placed.
105# The default is set as configured by the ``DEFAULT_GROUP`` option of 105​# The default is set as configured by the ``DEFAULT_GROUP`` option of
106# ``ecm_add_qtdesignerplugin``. 106​# ``ecm_add_qtdesignerplugin``.
107# 107​#
108# ``CREATE_WIDGET_CODE`` specifies C++ code to use as factory code to create 108​# ``CREATE_WIDGET_CODE_FROM_VARIABLE`` specifies the variable to get from the
109# an instance of the widget, for the override of 109​# C++ code to use as factory code to create an instance of the widget,
110​# for the override of
110# ``QDesignerCustomWidgetInterface::createWidget(QWidget* parent)``. 111​# ``QDesignerCustomWidgetInterface::createWidget(QWidget* parent)``.
111# Replace any occurence of ";" with "@SEMICOLON@", as needed to pass the raw 112​# The default is "return new <impl_class_name>${constructor_args_code_variable};".
112# code via CMake. The default is ​
113# "return new <impl_class_name><constructor_args_code>;". ​
114# 113​#
115# ``INITIALIZE_CODE`` specifies C++ code to use with the override of 114​# ``INITIALIZE_CODE_FROM_VARIABLE`` specifies the variable to get from the C++
115​# code to use with the override of
116# ``QDesignerCustomWidgetInterface::initialize(QDesignerFormEditorInterface* core)``. 116​# ``QDesignerCustomWidgetInterface::initialize(QDesignerFormEditorInterface* core)``.
117# The code has to use the present class member ``m_initialized`` to track and 117​# The code has to use the present class member ``m_initialized`` to track and
118# update the state. Replace any occurence of ";" with "@SEMICOLON@", as needed 118​# update the state. The default code simply sets ``m_initialized`` to
119# to pass the raw code via CMake. The default code simply sets 119​# ``true``, if it was not before.
120# ``m_initialized`` to ``true``, if it was not before. 120​#
121# 121​# ``DOM_XML_FROM_VARIABLE`` specifies the variable to get from the string to
122# ``DOM_XML`` specifies the string to use with the optional override of 122​# use with the optional override of
123# ``QDesignerCustomWidgetInterface::domXml()``. Replace any occurence of ";" 123​# ``QDesignerCustomWidgetInterface::domXml()``.
124# with "@SEMICOLON@", as needed to pass the raw XML string via CMake. ​
125# Default does not override. 124​# Default does not override.
126# 125​#
127# ``IMPL_CLASS_NAME`` specifies the name of the widget class to use for the 126​# ``IMPL_CLASS_NAME`` specifies the name of the widget class to use for the
128# widget instance with Qt Designer. The default is "<class_name>". 127​# widget instance with Qt Designer. The default is "<class_name>".
129# 128​#
130# ``CONSTRUCTOR_ARGS_CODE`` specifies the C++ code to use for the constructor 129​# ``CONSTRUCTOR_ARGS_CODE_FROM_VARIABLE`` specifies the variable to get from
131# arguments with the default of <create_widget_code>. Note that the 130​# the C++ code to use for the constructor arguments with the default of
132# parentheses are required. The default is "(parent)". 131​# ``CREATE_WIDGET_CODE_FROM_VARIABLE``. Note that the parentheses are
132​# required. The default is "(parent)".
133# 133​#
134# 134​#
135# 135​#
136# Example usage: 136​# Example usage:
137# 137​#
138# .. code-block:: cmake 138​# .. code-block:: cmake
139# 139​#
140# ecm_qtdesignerplugin_widget(FooWidget 140​# ecm_qtdesignerplugin_widget(FooWidget
141# TOOLTIP "Enables to browse foo." 141​# TOOLTIP "Enables to browse foo."
142# GROUP "Views (Foo)" 142​# GROUP "Views (Foo)"
143# ) 143​# )
144# 144​#
145​# set(BarWidget_CREATE_WIDGET_CODE
146​# "
147​# auto* widget = new BarWidget(parent);
148​# widget->setBar("Example bar");
149​# return widget;
150​# ")
151​#
145# ecm_qtdesignerplugin_widget(BarWidget 152​# ecm_qtdesignerplugin_widget(BarWidget
146# TOOLTIP "Displays bars." 153​# TOOLTIP "Displays bars."
147# GROUP "Display (Foo)" 154​# GROUP "Display (Foo)"
155​# CREATE_WIDGET_CODE_FROM_VARIABLE BarWidget_CREATE_WIDGET_CODE
148# ) 156​# )
149# 157​#
150# ecm_add_qtdesignerplugin(foowidgets 158​# ecm_add_qtdesignerplugin(foowidgets
151# NAME FooWidgets 159​# NAME FooWidgets
152# OUTPUT_NAME foo2widgets 160​# OUTPUT_NAME foo2widgets
153# WIDGETS 161​# WIDGETS
154# FooWidget 162​# FooWidget
155# BarWidget 163​# BarWidget
Show All 29 Lines
185# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 193​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
186# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 194​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
187# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 195​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
188# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 196​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
189 197​
190include(CMakeParseArguments) 198​include(CMakeParseArguments)
191 199​
192# helper method 200​# helper method
193# unescapes "@SEMICOLON@" into ";" ​
194function(_ecm_qtdesignerplugin_unescape_code _varName input) ​
195 string(REPLACE "@SEMICOLON@" ";" _code ${input}) ​
196 set(${_varName} "${_code}" PARENT_SCOPE) ​
197endfunction() ​
198 ​
199# helper method ​
200# escapes string for C++ code 201​# escapes string for C++ code
201function(_ecm_qtdesignerplugin_escape_cpp_string _varName input) 202​function(_ecm_qtdesignerplugin_escape_cpp_string _varName input)
202 string(REPLACE "\"" "\\\"" _string ${input}) 203​ string(REPLACE "\"" "\\\"" _string ${input})
203 set(${_varName} "${_string}" PARENT_SCOPE) 204​ set(${_varName} "${_string}" PARENT_SCOPE)
204endfunction() 205​endfunction()
205 206​
206# To make the data about the widgets available to the function ecm_add_qtdesignerplugin, 207​# To make the data about the widgets available to the function ecm_add_qtdesignerplugin,
207# variables are created in the scope of the caller of this method, protected by 208​# variables are created in the scope of the caller of this method, protected by
208# a namespace for this macro file, and otherwise from the widget id and the property id: 209​# a namespace for this macro file, and otherwise from the widget id and the property id:
209# ECM_QTDESIGNERPLUGIN_${widget}_${property} 210​# ECM_QTDESIGNERPLUGIN_${widget}_${property}
210function(ecm_qtdesignerplugin_widget widget) 211​function(ecm_qtdesignerplugin_widget widget)
211 set(options 212​ set(options
212 CONTAINER 213​ CONTAINER
213 ) 214​ )
214 set(oneValueArgs 215​ set(oneValueArgs
215 CLASS_NAME 216​ CLASS_NAME
216 INCLUDE_FILE 217​ INCLUDE_FILE
217 ICON 218​ ICON
218 TOOLTIP 219​ TOOLTIP
219 WHATSTHIS 220​ WHATSTHIS
220 GROUP 221​ GROUP
221 CREATE_WIDGET_CODE 222​ CREATE_WIDGET_CODE_FROM_VARIABLE
222 INITIALIZE_CODE 223​ INITIALIZE_CODE_FROM_VARIABLE
223 DOM_XML 224​ DOM_XML_FROM_VARIABLE
224 IMPL_CLASS_NAME 225​ IMPL_CLASS_NAME
225 CONSTRUCTOR_ARGS_CODE 226​ CONSTRUCTOR_ARGS_CODE_FROM_VARIABLE
226 ) 227​ )
227 set(multiValueArgs 228​ set(multiValueArgs
228 ) 229​ )
229 cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) 230​ cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
230 231​
231 if(NOT ARGS_CLASS_NAME) 232​ if(NOT ARGS_CLASS_NAME)
232 set(ARGS_CLASS_NAME "${widget}") 233​ set(ARGS_CLASS_NAME "${widget}")
233 endif() 234​ endif()
234 if(NOT ARGS_TOOLTIP) 235​ if(NOT ARGS_TOOLTIP)
235 set(ARGS_TOOLTIP "${ARGS_CLASS_NAME} Widget") 236​ set(ARGS_TOOLTIP "${ARGS_CLASS_NAME} Widget")
236 endif() 237​ endif()
237 if(NOT ARGS_WHATSTHIS) 238​ if(NOT ARGS_WHATSTHIS)
238 set(ARGS_WHATSTHIS "${ARGS_TOOLTIP}") 239​ set(ARGS_WHATSTHIS "${ARGS_TOOLTIP}")
239 endif() 240​ endif()
240 if(ARGS_CONTAINER) 241​ if(ARGS_CONTAINER)
241 set(_is_container TRUE) 242​ set(_is_container TRUE)
242 else() 243​ else()
243 set(_is_container FALSE) 244​ set(_is_container FALSE)
244 endif() 245​ endif()
245 if(NOT ARGS_CREATE_WIDGET_CODE) 246​ if(NOT ARGS_CREATE_WIDGET_CODE_FROM_VARIABLE)
246 if(NOT ARGS_IMPL_CLASS_NAME) 247​ if(NOT ARGS_IMPL_CLASS_NAME)
247 set(ARGS_IMPL_CLASS_NAME "${ARGS_CLASS_NAME}") 248​ set(ARGS_IMPL_CLASS_NAME "${ARGS_CLASS_NAME}")
248 endif() 249​ endif()
249 if(NOT ARGS_CONSTRUCTOR_ARGS_CODE) 250​ if(ARGS_CONSTRUCTOR_ARGS_CODE_FROM_VARIABLE)
250 set(ARGS_CONSTRUCTOR_ARGS_CODE "(parent)") 251​ set(_constructor_args "${${ARGS_CONSTRUCTOR_ARGS_CODE_FROM_VARIABLE}}")
252​ else()
253​ set(_constructor_args "(parent)")
251 endif() 254​ endif()
252 set(ARGS_CREATE_WIDGET_CODE " return new ${ARGS_IMPL_CLASS_NAME}${ARGS_CONSTRUCTOR_ARGS_CODE};") 255​ set(_create_widget_code " return new ${ARGS_IMPL_CLASS_NAME}${_constructor_args};")
253 else() 256​ else()
254 _ecm_qtdesignerplugin_unescape_code(ARGS_CREATE_WIDGET_CODE "${ARGS_CREATE_WIDGET_CODE}") 257​ set(_create_widget_code "${${ARGS_CREATE_WIDGET_CODE_FROM_VARIABLE}}")
255 endif() 258​ endif()
256 if(ARGS_ICON) 259​ if(ARGS_ICON)
257 if (NOT IS_ABSOLUTE ${ARGS_ICON}) 260​ if (NOT IS_ABSOLUTE ${ARGS_ICON})
258 set(ARGS_ICON "${CMAKE_CURRENT_SOURCE_DIR}/${ARGS_ICON}") 261​ set(ARGS_ICON "${CMAKE_CURRENT_SOURCE_DIR}/${ARGS_ICON}")
259 endif() 262​ endif()
260 if(NOT EXISTS "${ARGS_ICON}") 263​ if(NOT EXISTS "${ARGS_ICON}")
261 message(FATAL_ERROR "No such file as passed with ICON when calling ecm_qtdesignerplugin_widget(): ${ARGS_ICON}") 264​ message(FATAL_ERROR "No such file as passed with ICON when calling ecm_qtdesignerplugin_widget(): ${ARGS_ICON}")
262 endif() 265​ endif()
263 endif() 266​ endif()
264 267​
265 # store data about widget, so ecm_add_qtdesignerplugin can access it 268​ # store data about widget, so ecm_add_qtdesignerplugin can access it
266 set(ECM_QTDESIGNERPLUGIN_${widget}_CLASS_NAME "${ARGS_CLASS_NAME}" PARENT_SCOPE) 269​ set(ECM_QTDESIGNERPLUGIN_${widget}_CLASS_NAME "${ARGS_CLASS_NAME}" PARENT_SCOPE)
267 set(ECM_QTDESIGNERPLUGIN_${widget}_INCLUDE_FILE "${ARGS_INCLUDE_FILE}" PARENT_SCOPE) 270​ set(ECM_QTDESIGNERPLUGIN_${widget}_INCLUDE_FILE "${ARGS_INCLUDE_FILE}" PARENT_SCOPE)
268 set(ECM_QTDESIGNERPLUGIN_${widget}_TOOLTIP "${ARGS_TOOLTIP}" PARENT_SCOPE) 271​ set(ECM_QTDESIGNERPLUGIN_${widget}_TOOLTIP "${ARGS_TOOLTIP}" PARENT_SCOPE)
269 set(ECM_QTDESIGNERPLUGIN_${widget}_WHATSTHIS "${ARGS_WHATSTHIS}" PARENT_SCOPE) 272​ set(ECM_QTDESIGNERPLUGIN_${widget}_WHATSTHIS "${ARGS_WHATSTHIS}" PARENT_SCOPE)
270 set(ECM_QTDESIGNERPLUGIN_${widget}_GROUP "${ARGS_GROUP}" PARENT_SCOPE) 273​ set(ECM_QTDESIGNERPLUGIN_${widget}_GROUP "${ARGS_GROUP}" PARENT_SCOPE)
271 set(ECM_QTDESIGNERPLUGIN_${widget}_ICON "${ARGS_ICON}" PARENT_SCOPE) 274​ set(ECM_QTDESIGNERPLUGIN_${widget}_ICON "${ARGS_ICON}" PARENT_SCOPE)
272 set(ECM_QTDESIGNERPLUGIN_${widget}_IS_CONTAINER "${_is_container}" PARENT_SCOPE) 275​ set(ECM_QTDESIGNERPLUGIN_${widget}_IS_CONTAINER "${_is_container}" PARENT_SCOPE)
273 set(ECM_QTDESIGNERPLUGIN_${widget}_CREATE_WIDGET_CODE "${ARGS_CREATE_WIDGET_CODE}" PARENT_SCOPE) 276​ set(ECM_QTDESIGNERPLUGIN_${widget}_CREATE_WIDGET_CODE "${_create_widget_code}" PARENT_SCOPE)
274 set(ECM_QTDESIGNERPLUGIN_${widget}_INITIALIZE_CODE "${ARGS_INITIALIZE_CODE}" PARENT_SCOPE) 277​ set(ECM_QTDESIGNERPLUGIN_${widget}_INITIALIZE_CODE "${${INITIALIZE_CODE_FROM_VARIABLE}}" PARENT_SCOPE)
275 set(ECM_QTDESIGNERPLUGIN_${widget}_DOM_XML "${ARGS_DOM_XML}" PARENT_SCOPE) 278​ set(ECM_QTDESIGNERPLUGIN_${widget}_DOM_XML "${${ARGS_DOM_XML_FROM_VARIABLE}}" PARENT_SCOPE)
276endfunction() 279​endfunction()
277 280​
278# helper method 281​# helper method
279function(_ecm_qtdesignerplugin_write_widget designer_src_file widget default_group rc_icon_dir) 282​function(_ecm_qtdesignerplugin_write_widget designer_src_file widget default_group rc_icon_dir)
280 # prepare data 283​ # prepare data
281 set(_classname "${ECM_QTDESIGNERPLUGIN_${widget}_CLASS_NAME}") 284​ set(_classname "${ECM_QTDESIGNERPLUGIN_${widget}_CLASS_NAME}")
282 set(_factory_classname "${_classname}QtDesignerWidgetFactory") 285​ set(_factory_classname "${_classname}QtDesignerWidgetFactory")
283 string(REPLACE "::" "__" _factory_classname "${_factory_classname}") 286​ string(REPLACE "::" "__" _factory_classname "${_factory_classname}")
284 set(ECM_QTDESIGNERPLUGIN_${widget}_FACTORY_CLASS_NAME "${_factory_classname}" PARENT_SCOPE) 287​ set(ECM_QTDESIGNERPLUGIN_${widget}_FACTORY_CLASS_NAME "${_factory_classname}" PARENT_SCOPE)
285 if(ECM_QTDESIGNERPLUGIN_${widget}_IS_CONTAINER) 288​ if(ECM_QTDESIGNERPLUGIN_${widget}_IS_CONTAINER)
286 set(_is_container "true") 289​ set(_is_container "true")
287 else() 290​ else()
288 set(_is_container "false") 291​ set(_is_container "false")
289 endif() 292​ endif()
290 _ecm_qtdesignerplugin_escape_cpp_string(_tooltip "${ECM_QTDESIGNERPLUGIN_${widget}_TOOLTIP}") 293​ _ecm_qtdesignerplugin_escape_cpp_string(_tooltip "${ECM_QTDESIGNERPLUGIN_${widget}_TOOLTIP}")
291 _ecm_qtdesignerplugin_escape_cpp_string(_whatsthis "${ECM_QTDESIGNERPLUGIN_${widget}_WHATSTHIS}") 294​ _ecm_qtdesignerplugin_escape_cpp_string(_whatsthis "${ECM_QTDESIGNERPLUGIN_${widget}_WHATSTHIS}")
292 set(_group ${ECM_QTDESIGNERPLUGIN_${widget}_GROUP}) 295​ set(_group ${ECM_QTDESIGNERPLUGIN_${widget}_GROUP})
293 if(NOT _group) 296​ if(NOT _group)
294 set(_group "${default_group}") 297​ set(_group "${default_group}")
295 endif() 298​ endif()
296 _ecm_qtdesignerplugin_escape_cpp_string(_group "${_group}") 299​ _ecm_qtdesignerplugin_escape_cpp_string(_group "${_group}")
297 set(_dom_xml "${ECM_QTDESIGNERPLUGIN_${widget}_DOM_XML}") 300​ set(_dom_xml "${ECM_QTDESIGNERPLUGIN_${widget}_DOM_XML}")
298 if(_dom_xml) 301​ if(_dom_xml)
299 _ecm_qtdesignerplugin_unescape_code(_dom_xml "${_dom_xml}") ​
300 string(REPLACE "\"" "\\\"" _dom_xml "${_dom_xml}") 302​ string(REPLACE "\"" "\\\"" _dom_xml "${_dom_xml}")
301 set(_dom_xml_method " QString domXml() const override { return QStringLiteral(\"${_dom_xml}\"); }") 303​ set(_dom_xml_method " QString domXml() const override { return QStringLiteral(\"${_dom_xml}\"); }")
302 else() 304​ else()
303 set(_dom_xml_method) 305​ set(_dom_xml_method)
304 endif() 306​ endif()
305 set(_icon "${ECM_QTDESIGNERPLUGIN_${widget}_ICON}") 307​ set(_icon "${ECM_QTDESIGNERPLUGIN_${widget}_ICON}")
306 if(_icon) 308​ if(_icon)
307 get_filename_component(_icon_filename ${_icon} NAME) 309​ get_filename_component(_icon_filename ${_icon} NAME)
308 set(_icon_construct "QIcon(QStringLiteral(\":${rc_icon_dir}/${_icon_filename}\"))") 310​ set(_icon_construct "QIcon(QStringLiteral(\":${rc_icon_dir}/${_icon_filename}\"))")
309 else() 311​ else()
310 set(_icon_construct "QIcon()") 312​ set(_icon_construct "QIcon()")
311 endif() 313​ endif()
312 set(_initialize_code "${ECM_QTDESIGNERPLUGIN_${widget}_INITIALIZE_CODE}") 314​ set(_initialize_code "${ECM_QTDESIGNERPLUGIN_${widget}_INITIALIZE_CODE}")
313 if(NOT _initialize_code) 315​ if(NOT _initialize_code)
314 set(_initialize_code 316​ set(_initialize_code
315" Q_UNUSED(core); 317​" Q_UNUSED(core);
316 318​
317 if (m_initialized) return; 319​ if (m_initialized) return;
318 320​
319 m_initialized = true;" 321​ m_initialized = true;"
320 ) 322​ )
321 else() ​
322 _ecm_qtdesignerplugin_unescape_code(_initialize_code "${_initialize_code}") ​
323 endif() 323​ endif()
324 324​
325 # write code 325​ # write code
326 file(APPEND ${designer_src_file} " 326​ file(APPEND ${designer_src_file} "
327class ${_factory_classname} 327​class ${_factory_classname}
328 : public QObject 328​ : public QObject
329 , public QDesignerCustomWidgetInterface 329​ , public QDesignerCustomWidgetInterface
330{ 330​{
▲ Show 20 Lines • Show All 335 Lines • Show Last 20 Lines