Skip to content

Messagebox

This class contains various static methods that show popups with a message to the end user with various arrangments of buttons and alert options.

Source code in src/ttkbootstrap/dialogs/message.py 
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
class Messagebox:
    """This class contains various static methods that show popups with
    a message to the end user with various arrangments of buttons
    and alert options."""

    @staticmethod
    def show_info(
            message: str,
            title: str = " ",
            parent: Optional[tkinter.Misc] = None,
            alert: bool = False,
            **kwargs: Any,
    ) -> None:
        """Display a modal dialog box with an OK button and an INFO icon."""
        dialog = MessageDialog(
            message=message,
            title=title,
            alert=alert,
            parent=parent,
            buttons=["OK:primary"],
            icon=Icon.info,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)

    @staticmethod
    def show_warning(
            message: str,
            title: str = " ",
            parent: Optional[tkinter.Misc] = None,
            alert: bool = True,
            **kwargs: Any,
    ) -> None:
        """Display a modal dialog box with an OK button and a warning icon."""
        dialog = MessageDialog(
            message=message,
            title=title,
            parent=parent,
            buttons=["OK:primary"],
            icon=Icon.warning,
            alert=alert,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)

    @staticmethod
    def show_error(
            message: str,
            title: str = " ",
            parent: Optional[tkinter.Misc] = None,
            alert: bool = True,
            **kwargs: Any,
    ) -> None:
        """Display a modal dialog box with an OK button and an error icon."""
        dialog = MessageDialog(
            message=message,
            title=title,
            parent=parent,
            buttons=["OK:primary"],
            icon=Icon.error,
            alert=alert,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)

    @staticmethod
    def show_question(
            message: str,
            title: str = " ",
            parent: Optional[tkinter.Misc] = None,
            alert: bool = False,
            **kwargs: Any,
    ) -> None:
        """Display a modal dialog box with an OK button and a question icon."""
        dialog = MessageDialog(
            message=message,
            title=title,
            parent=parent,
            buttons=["OK:primary"],
            icon=Icon.question,
            alert=alert,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)

    @staticmethod
    def ok(
            message: str,
            title: str = " ",
            parent: Optional[tkinter.Misc] = None,
            alert: bool = False,
            **kwargs: Any,
    ) -> None:
        dialog = MessageDialog(
            title=title,
            message=message,
            parent=parent,
            alert=alert,
            buttons=["OK:primary"],
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)

    @staticmethod
    def okcancel(
            message: str,
            title: str = " ",
            alert: bool = False,
            parent: Optional[tkinter.Misc] = None,
            **kwargs: Any,
    ) -> Optional[str]:
        dialog = MessageDialog(
            title=title,
            message=message,
            parent=parent,
            alert=alert,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)
        return dialog.result

    @staticmethod
    def yesno(
            message: str,
            title: str = " ",
            alert: bool = False,
            parent: Optional[tkinter.Misc] = None,
            **kwargs: Any,
    ) -> Optional[str]:
        dialog = MessageDialog(
            title=title,
            message=message,
            parent=parent,
            buttons=["No", "Yes"],
            alert=alert,
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)
        return dialog.result

    @staticmethod
    def yesnocancel(
            message: str,
            title: str = " ",
            alert: bool = False,
            parent: Optional[tkinter.Misc] = None,
            **kwargs: Any,
    ) -> Optional[str]:
        dialog = MessageDialog(
            title=title,
            message=message,
            parent=parent,
            alert=alert,
            buttons=["Cancel", "No", "Yes"],
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)
        return dialog.result

    @staticmethod
    def retrycancel(
            message: str,
            title: str = " ",
            alert: bool = False,
            parent: Optional[tkinter.Misc] = None,
            **kwargs: Any,
    ) -> Optional[str]:
        dialog = MessageDialog(
            title=title,
            message=message,
            parent=parent,
            alert=alert,
            buttons=["Cancel", "Retry"],
            localize=True,
            **kwargs,
        )
        position = kwargs.pop("position", None)
        dialog.show(position)
        return dialog.result

show_error(message, title=' ', parent=None, alert=True, **kwargs) staticmethod

Display a modal dialog box with an OK button and an error icon.

Source code in src/ttkbootstrap/dialogs/message.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
@staticmethod
def show_error(
        message: str,
        title: str = " ",
        parent: Optional[tkinter.Misc] = None,
        alert: bool = True,
        **kwargs: Any,
) -> None:
    """Display a modal dialog box with an OK button and an error icon."""
    dialog = MessageDialog(
        message=message,
        title=title,
        parent=parent,
        buttons=["OK:primary"],
        icon=Icon.error,
        alert=alert,
        localize=True,
        **kwargs,
    )
    position = kwargs.pop("position", None)
    dialog.show(position)

show_info(message, title=' ', parent=None, alert=False, **kwargs) staticmethod

Display a modal dialog box with an OK button and an INFO icon.

Source code in src/ttkbootstrap/dialogs/message.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
@staticmethod
def show_info(
        message: str,
        title: str = " ",
        parent: Optional[tkinter.Misc] = None,
        alert: bool = False,
        **kwargs: Any,
) -> None:
    """Display a modal dialog box with an OK button and an INFO icon."""
    dialog = MessageDialog(
        message=message,
        title=title,
        alert=alert,
        parent=parent,
        buttons=["OK:primary"],
        icon=Icon.info,
        localize=True,
        **kwargs,
    )
    position = kwargs.pop("position", None)
    dialog.show(position)

show_question(message, title=' ', parent=None, alert=False, **kwargs) staticmethod

Display a modal dialog box with an OK button and a question icon.

Source code in src/ttkbootstrap/dialogs/message.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
@staticmethod
def show_question(
        message: str,
        title: str = " ",
        parent: Optional[tkinter.Misc] = None,
        alert: bool = False,
        **kwargs: Any,
) -> None:
    """Display a modal dialog box with an OK button and a question icon."""
    dialog = MessageDialog(
        message=message,
        title=title,
        parent=parent,
        buttons=["OK:primary"],
        icon=Icon.question,
        alert=alert,
        localize=True,
        **kwargs,
    )
    position = kwargs.pop("position", None)
    dialog.show(position)

show_warning(message, title=' ', parent=None, alert=True, **kwargs) staticmethod

Display a modal dialog box with an OK button and a warning icon.

Source code in src/ttkbootstrap/dialogs/message.py 
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
@staticmethod
def show_warning(
        message: str,
        title: str = " ",
        parent: Optional[tkinter.Misc] = None,
        alert: bool = True,
        **kwargs: Any,
) -> None:
    """Display a modal dialog box with an OK button and a warning icon."""
    dialog = MessageDialog(
        message=message,
        title=title,
        parent=parent,
        buttons=["OK:primary"],
        icon=Icon.warning,
        alert=alert,
        localize=True,
        **kwargs,
    )
    position = kwargs.pop("position", None)
    dialog.show(position)