Module bitcoin_qt::gui_util

source ·
Expand description

| Utility functions used by the Bitcoin | Qt UI. |

Structs

  • ClickableLabel
  • ClickableProgressBar
  • ItemDelegate
  • LabelOutOfFocusEventFilter
    | Qt event filter that intercepts QEvent::FocusOut | events for QLabel objects, and resets | their `textInteractionFlags’ property | to get rid of the visible cursor. | | This is a temporary fix of QTBUG-59514. |
  • ThemedLabel
  • ToolTipToRichTextFilter
    | Qt event filter that intercepts ToolTipChange | events, and replaces the tooltip with | a rich text representation if needed. | This assures that Qt can word-wrap long | tooltip messages. | | Tooltips longer than the provided size | threshold (in characters) are wrapped. |

Constants

  • DIALOG_FLAGS
    | Use this flags to prevent a “What’s This” | button in the title bar of the dialog | on | | Windows. |
  • DUMMYDATA
    | Just some dummy data to generate a convincing | random-looking (but consistent) address |

Functions

  • add_button_shortcut
    | Connects an additional shortcut to | a QAbstractButton. Works around the | one shortcut limitation of the button’s | shortcut property. | | ———– | @param[in] button | | QAbstractButton to assign shortcut | to | ––––– | @param[in] shortcut | | QKeySequence to use as shortcut |
  • blocking_gui_thread_connection
    | Get connection type to call object slot | in GUI thread with invokeMethod. The | call will be blocking. | | ———– | @return | | If called from the GUI thread, return | a QtDirectConnection. | | If called from another thread, return | a QtBlockingQueuedConnection. |
  • boost_path_to_qstring
    | Convert OS specific boost path to QString | through UTF-8 |
  • bring_to_front
    | Activate, show and raise the widget |
  • calculate_ideal_font_size
  • check_point
  • connection_type_to_qstring
    | Convert enum ConnectionType to QString |
  • copy_entry_data
    | Copy a field of the currently selected | entry of a view to the clipboard. Does | nothing if nothing is selected. | | ———– | @param[in] column | | Data column to extract from the model | ––––– | @param[in] role | | Data role to extract from the model @see | TransactionView::copyLabel, TransactionView::copyAmount, | TransactionView::copyAddress |
  • date_time_str
  • date_time_str_from_qdatetime
    | Create human-readable string from | date |
  • dummy_address
    | Generate a dummy address with invalid | CRC, starting with the network prefix. |
  • exception_safe_connect
    | A drop-in replacement of QObject::connect | function (see: https://doc.qt.io/qt-5/qobject.html#connect-3), | that guaranties that all exceptions | are handled within the slot. | | ———– | @note | | This function is incompatible with | Qt private signals. |
  • fixed_pitch_font
    | Return a monospace font |
  • format_bitcoinuri
  • format_bytes
  • format_duration_str
    | Convert seconds into a QString with | days, hours, mins, secs |
  • format_nice_time_offset
  • format_ping_time
    | Format a NodeStats.m_last_ping_time | into a user-readable string or display | N/A, if 0 |
  • format_services_str
    | Format NodeStats.nServices bitmask | into a user-readable string |
  • format_time_offset
    | Format a NodeCombinedStats.nTimeOffset | into a user-readable string |
  • get_default_data_directory
    | Determine default data directory for | operating system. |
  • get_entry_data
    | Return a field of the currently selected | entry as a QString. Does nothing if nothing | is selected. | | ———– | @param[in] column | | Data column to extract from the model | @see TransactionView::copyLabel, | TransactionView::copyAmount, TransactionView::copyAddress |
  • get_image
  • get_open_file_name
    | Get open filename, convenience wrapper | for QFileDialog::getOpenFileName. | | ———– | @param[in] parent | | Parent window (or 0) | ––––– | @param[in] caption | | Window caption (or empty, for default) | ––––– | @param[in] dir | | Starting directory (or empty, to default | to documents directory) | ––––– | @param[in] filter | | Filter specification such as “Comma | Separated Files (*.csv)” | ––––– | @param[out] selectedSuffixOut | | Pointer to return the suffix (file type) | that was selected (or 0). | | Can be useful when choosing the save | file format based on suffix. |
  • get_save_file_name
    | Get save filename, mimics QFileDialog::getSaveFileName, | except that it appends a default suffix | when no suffix is provided by the user. | | ———– | @param[in] parent | | Parent window (or 0) | ––––– | @param[in] caption | | Window caption (or empty, for default) | ––––– | @param[in] dir | | Starting directory (or empty, to default | to documents directory) | ––––– | @param[in] filter | | Filter specification such as “Comma | Separated Files (*.csv)” | ––––– | @param[out] selectedSuffixOut | | Pointer to return the suffix (file type) | that was selected (or 0). | | Can be useful when choosing the save | file format based on suffix. |
  • get_start_on_system_startup
  • handle_close_window_shortcut
    | Set shortcut to close window |
  • has_entry_data
    | Returns true if the specified field | of the currently selected view entry | is not empty. | | ———– | @param[in] column | | Data column to extract from the model | ––––– | @param[in] role | | Data role to extract from the model @see | TransactionView::contextualMenu |
  • has_pixmap
    | Returns true if pixmap has been set. | | QPixmap* QLabel::pixmap() is deprecated | since Qt 5.15. |
  • html_escape
    | HTML escaping for rich text controls |
  • is_dust
    | Returns true if given address+amount | meets “dust” definition |
  • is_obscured
    | Determine whether a widget is hidden | behind other windows |
  • load_font
    | Loads the font from the file specified | by file_name, aborts if it fails. |
  • log_qt_info
    | Writes to debug.log short info about | the used Qt and the host system. |
  • make_html_link
    | Replaces a plain text link with an HTML | tagged one. |
  • network_to_qstring
    | Convert enum Network to QString |
  • object_invoke
    | Queue a function to run in an object’s | event loop. This can be replaced by a | call to the QMetaObject::invokeMethod | functor overload after Qt 5.10, but | for now use a QObject::connect for compatibility | with older Qt versions, based on https://stackoverflow.com/questions/21646467/how-to-execute-a-functor-or-a-lambda-in-a-given-thread-in-qt-gcd-style |
  • open_bitcoin_conf
    | Open the config file |
  • open_debug_logfile
    | Open debug.log |
  • parse_bitcoinuri
  • parse_bitcoinuri_with_qurl
    | Parse “bitcoin:” URI into recipient | object, return true on successful parsing |
  • polish_progress_dialog
    | Fix known bugs in QProgressDialog class. |
  • popup_menu
    | Call QMenu::popup() only on supported | QT_QPA_PLATFORM. |
  • print_slot_exception
  • qstring_to_boost_path
    | Convert QString to OS specific boost | path through UTF-8 |
  • set_clipboard
  • set_start_on_system_startup
  • setup_address_widget
    | Set up widget for address |
  • show_modal_dialog_and_delete_on_close
    | Shows a QDialog instance asynchronously, | and deletes it on close. |
  • split_skip_empty_parts
    | Splits the string into substrings wherever | separator occurs, and returns the list | of those strings. Empty strings do not | appear in the result. | | QString::split() signature differs | in different Qt versions: | | - QString::SplitBehavior is deprecated | since Qt 5.15 | | - QtSplitBehavior was introduced | in Qt 5.14 | | If {QString|Qt}::SkipEmptyParts | behavior is required, use this function | instead of QString::split(). |
  • start_of_day
    | Returns the start-moment of the day | in local time. | | QDateTime::QDateTime(const QDate& | date) is deprecated since Qt 5.15. | | QDate::startOfDay() was introduced | in Qt 5.14. |
  • text_width
    | Returns the distance in pixels appropriate | for drawing a subsequent character | after text. | | In Qt 5.12 and before the QFontMetrics::width() | is used and it is deprecated since Qt | 5.13. | | In Qt 5.11 the QFontMetrics::horizontalAdvance() | was introduced. |

Type Definitions