Boost.UI
User Interface Boost library
Classes | Typedefs | Enumerations | Functions | Variables
boost::ui Namespace Reference

Boost.UI library namespace. More...

Classes

class  basic_point
 2D point data structure with custom coordinates type More...
 
class  basic_rect
 2D rectangle plane figure data structure with custom coordinates type More...
 
class  basic_size
 2D size of object data structure with custom coordinates type More...
 
class  box_layout
 Abstract vertical or horizontal box layout. More...
 
class  button
 Widget with label that generate event when clicked on. More...
 
class  canvas
 Widget for drawing. More...
 
class  check_box
 Labelled widget that that permits the user to make a binary choice. More...
 
class  check_box_base
 Check box base class. More...
 
class  choice
 Widget to select string from popup list of strings. More...
 
class  close_event
 Close event class. More...
 
class  color
 Color class. More...
 
class  combo_box
 Widget to select one or more strings and edit it. More...
 
class  date_picker
 Date picker widget. More...
 
class  dialog
 Top level widget that hosts other widgets. More...
 
class  event
 Base class for all events. More...
 
class  event_loop
 Event loop class. More...
 
class  font
 Font class. More...
 
class  frame
 Top level widget that hosts other widgets and supports menu bar. More...
 
class  group_box
 Widget that groups other widgets using a frame and a title. More...
 
class  hbox
 Horizontal box layout. More...
 
class  hline
 Horizontal line widget. More...
 
class  hprogress_bar
 Horizontal progress bar widget. More...
 
class  hslider
 Horizontal slider widget. More...
 
class  hyperlink
 Widget that displays static text which links to an URL. More...
 
class  image
 Image class. More...
 
class  image_widget
 Widget that displays image. More...
 
class  index_event
 Event class that holds some index in container. More...
 
class  key_event
 Keyboard event class that holds information about keyboard when event was generated. More...
 
class  keyboard_state
 Keyboard state class. More...
 
class  label
 Widget that displays static text. More...
 
class  layout
 Base class for all layouts. More...
 
class  line_widget
 Abstract widget that displays horizontal or vertical line. More...
 
class  list_box
 Widget to select one or more strings. More...
 
class  log
 Logging stream class. More...
 
class  log_string
 Logging stream class with output into provided uistring. More...
 
class  menu
 Menu (list of commands) class. More...
 
class  menu_bar
 Menu bar class. More...
 
class  mouse_event
 Mouse event class that holds information about mouse when event was generated. More...
 
class  native_widget
 Widget that wraps previously created native widget. More...
 
class  notebook
 Widget that is an array of tabbed widgets. More...
 
class  painter
 2D graphics rendering painter More...
 
class  panel
 Widget that hosts other widgets. More...
 
class  password_box
 Password editor widget. More...
 
class  progress_bar
 Progress bar widget base class. More...
 
class  separator
 Pseudo class that separates menu items. More...
 
class  slider
 Slider widget base class. More...
 
class  status_bar
 Status bar class. More...
 
class  string_box
 Single-line text editor widget. More...
 
class  strings_box
 Abstract widget that holds array of strings. More...
 
class  text_box
 Multi-line text editor widget. More...
 
class  text_box_base
 Abstract text editor widget. More...
 
class  time_picker
 Time picker widget. More...
 
class  tri_state_check_box
 Labelled widget that that permits the user to make a ternary choice. More...
 
class  uiostringstream
 Output string stream that collects data for UI. More...
 
class  uistring
 Helper class to convert string between UI and application logic only. More...
 
class  vbox
 Vertical box layout. More...
 
class  vline
 Vertical line widget. More...
 
class  vprogress_bar
 Vertical progress bar widget. More...
 
class  vslider
 Vertical slider widget. More...
 
class  web_widget
 Widget that renders HTML. More...
 
class  wheel_event
 Mouse wheel event class. More...
 
class  widget
 Base class for all widgets. More...
 
class  window
 Abstract top level widget that hosts other widgets. More...
 

Typedefs

typedef basic_size< painter::gcoord_typegsize
 2D size geometry coordinates
 
typedef basic_point< painter::gcoord_typegpoint
 2D point geometry coordinates
 
typedef basic_rect< painter::gcoord_typegrect
 2D rectangle geometry coordinates
 
typedef int index_type
 Integral type for indexing items.
 
typedef int coord_type
 Widget coordinates signed number type.
 
typedef basic_size< coord_typesize
 2D size coordinates
 
typedef basic_point< coord_typepoint
 2D point coordinates
 
typedef basic_rect< coord_typerect
 2D rectangle coordinates
 

Enumerations

enum  line_cap { line_cap::butt, line_cap::round, line_cap::square }
 Enumaration of line endings types. More...
 
enum  line_join { line_join::round, line_join::bevel, line_join::miter }
 Enumaration of line join types. More...
 

Functions

template<class F , class... Args>
void call_async (F &&f, Args &&...args)
 Calls f in the idle time in UI thread. This function is thread safe. More...
 
std::size_t hash_value (const uistring &value)
 Returns hash of uistring for boost::hash. More...
 
BOOST_UI_DECL void info_notify (const uistring &message, const uistring &title=ascii("Information"))
 Display information as an non intrusive notification.
 
BOOST_UI_DECL void warning_notify (const uistring &message, const uistring &title=ascii("Warning"))
 Display warning as an non intrusive notification.
 
BOOST_UI_DECL void error_notify (const uistring &message, const uistring &title=ascii("Error"))
 Display error as an non intrusive notification.
 
BOOST_UI_DECL void info_dialog (const uistring &message, const uistring &title=ascii("Information"))
 Display information in application-modal dialog.
 
BOOST_UI_DECL void warning_dialog (const uistring &message, const uistring &title=ascii("Warning"))
 Display warning in application-modal dialog.
 
BOOST_UI_DECL void error_dialog (const uistring &message, const uistring &title=ascii("Error"))
 Display error in application-modal dialog.
 
BOOST_UI_DECL bool confirm (const uistring &message, const uistring &title=ascii("Confirmation"))
 Request user confirmation using application-modal dialog. More...
 
BOOST_UI_DECL bool question (const uistring &message, const uistring &title=ascii("Question"))
 Request user answer using application-modal dialog.
 
std::locale getloc ()
 Returns the current locale associated with the user interface.
 
template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const basic_size< T > &p)
 Writes basic_size into basic_size stream. More...
 
template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const basic_point< T > &p)
 Writes basic_point into the stream. More...
 
template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const basic_rect< T > &r)
 Writes basic_rect into the stream. More...
 
void beep ()
 Rings the system bell. More...
 
template<class Traits >
std::basic_ostream< char, Traits > & operator<< (std::basic_ostream< char, Traits > &os, const uistring &str)
 Writes string into the stream. More...
 
template<class Traits >
std::basic_ostream< wchar_t, Traits > & operator<< (std::basic_ostream< wchar_t, Traits > &os, const uistring &str)
 Writes string into the stream. More...
 
template<class Traits >
std::basic_ostream< char16_t, Traits > & operator<< (std::basic_ostream< char16_t, Traits > &os, const uistring &str)
 Writes string into the stream. More...
 
template<class Traits >
std::basic_ostream< char32_t, Traits > & operator<< (std::basic_ostream< char32_t, Traits > &os, const uistring &str)
 Writes string into the stream. More...
 
template<class Traits >
std::basic_istream< char, Traits > & operator>> (std::basic_istream< char, Traits > &is, ui::uistring &str)
 Reads string from the stream. More...
 
template<class Traits >
std::basic_istream< wchar_t, Traits > & operator>> (std::basic_istream< wchar_t, Traits > &is, ui::uistring &str)
 Reads string from the stream. More...
 
template<class Traits >
std::basic_istream< char16_t, Traits > & operator>> (std::basic_istream< char16_t, Traits > &is, ui::uistring &str)
 Reads string from the stream. More...
 
template<class Traits >
std::basic_istream< char32_t, Traits > & operator>> (std::basic_istream< char32_t, Traits > &is, ui::uistring &str)
 Reads string from the stream. More...
 
uistring u8uistring (const char *str)
 Constructs uistring from UTF-8 encoded string. More...
 
uistring u8uistring (const std::string &str)
 Constructs uistring from UTF-8 encoded string. More...
 
uistring utf8 (const char *str)
 Constructs uistring from UTF-8 encoded string. More...
 
uistring utf8 (const std::string &str)
 Constructs uistring from UTF-8 encoded string. More...
 
uistring asciiuistring (const char *str)
 Constructs uistring from 7-bit ASCII encoded string. More...
 
uistring asciiuistring (const std::string &str)
 Constructs uistring from 7-bit ASCII encoded string. More...
 
uistring ascii (const char *str)
 Constructs uistring from 7-bit ASCII encoded string. More...
 
uistring ascii (const std::string &str)
 Constructs uistring from 7-bit ASCII encoded string. More...
 
uistring operator+ (const uistring &lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, uistring &&rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, uistring &&rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, wchar_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, const wchar_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (wchar_t lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const wchar_t *lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, char16_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, const char16_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (char16_t lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const char16_t *lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, char32_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const uistring &lhs, const char32_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (char32_t lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (const char32_t *lhs, const uistring &rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, wchar_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, const wchar_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, char16_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, const char16_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, char32_t rhs)
 Concatenates two strings or the string and the character. More...
 
uistring operator+ (uistring &&lhs, const char32_t *rhs)
 Concatenates two strings or the string and the character. More...
 
uistring to_uistring (int value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (unsigned int value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (long value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (unsigned long value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (long long value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (unsigned long long value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (float value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (double value)
 Converts numeric value to uistring. More...
 
uistring to_uistring (long double value)
 Converts numeric value to uistring. More...
 
BOOST_UI_DECL bool prompt (const uistring &message, const uistring &title, std::wstring &value)
 Request user value using application-modal dialog.
 
BOOST_UI_DECL bool prompt (const uistring &message, const uistring &title, uistring &value)
 Request user value using application-modal dialog.
 
BOOST_UI_DECL bool prompt_password (const uistring &message, const uistring &title, std::wstring &value)
 Request user password using application-modal dialog.
 
BOOST_UI_DECL bool prompt_password (const uistring &message, const uistring &title, uistring &value)
 Request user password using application-modal dialog.
 
BOOST_UI_DECL bool prompt_filename (const uistring &title, std::wstring &value)
 Request user filename using application-modal dialog. More...
 
BOOST_UI_DECL bool prompt_filename (const uistring &title, uistring &value)
 Request user filename using application-modal dialog. More...
 
bool prompt_filename (const uistring &title, boost::filesystem::path &value)
 Request user filename using application-modal dialog. More...
 
BOOST_UI_DECL bool prompt_directory (const uistring &title, std::wstring &value)
 Request user directory using application-modal dialog. More...
 
BOOST_UI_DECL bool prompt_directory (const uistring &title, uistring &value)
 Request user directory using application-modal dialog. More...
 
bool prompt_directory (const uistring &title, boost::filesystem::path &value)
 Request user directory using application-modal dialog. More...
 
BOOST_UI_DECL bool prompt_color (const uistring &title, color &value)
 Request color using application-modal dialog.
 
template<class T >
basic_size< T > operator* (const T &value, const basic_size< T > &rhs)
 Arithmetic operation.
 
template<class T >
basic_size< T > operator* (const basic_size< T > &lhs, const T &value)
 Arithmetic operation.
 
template<class T >
basic_size< T > operator/ (const basic_size< T > &lhs, const T &value)
 Arithmetic operation.
 
template<class T >
basic_point< T > operator+ (const basic_point< T > &lhs, const basic_size< T > &rhs)
 Arithmetic operation.
 
template<class T >
basic_point< T > operator- (const basic_point< T > &lhs, const basic_size< T > &rhs)
 Arithmetic operation.
 
template<class T >
basic_size< T > operator- (const basic_point< T > &lhs, const basic_point< T > &rhs)
 Arithmetic operation.
 
template<class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const boost::ui::color &c)
 Writes color into the stream. More...
 
bool operator== (const color &lhs, const color &rhs) noexcept
 Compares two colors. More...
 
bool operator!= (const color &lhs, const color &rhs) noexcept
 Compares two colors. More...
 
int entry (int(*ui_main)(int, char *[]), int argc, char *argv[])
 UI application entry. More...
 
int entry (int(*ui_main)(), int argc, char *argv[])
 UI application entry. More...
 
template<class Rep , class Period , class F , class... Args>
void on_timeout (const std::chrono::duration< Rep, Period > &d, F &&f, Args &&...args)
 Calls function one time after the specified time duration. More...
 

Variables

const index_type nindex = -1
 Invalid index value.
 

Detailed Description

Boost.UI library namespace.

Function Documentation

uistring boost::ui::ascii ( const char *  str)
inline

Constructs uistring from 7-bit ASCII encoded string.

uistring boost::ui::ascii ( const std::string &  str)
inline

Constructs uistring from 7-bit ASCII encoded string.

uistring asciiuistring ( const char *  str)
inline

Constructs uistring from 7-bit ASCII encoded string.

uistring boost::ui::asciiuistring ( const std::string &  str)
inline

Constructs uistring from 7-bit ASCII encoded string.

std::size_t hash_value ( const uistring value)

Returns hash of uistring for boost::hash.

bool boost::ui::operator!= ( const color lhs,
const color rhs 
)
inlinenoexcept

Compares two colors.

uistring operator+ ( const uistring lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
uistring &&  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
uistring &&  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
wchar_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
const wchar_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( wchar_t  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const wchar_t *  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
char16_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
const char16_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( char16_t  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const char16_t *  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
char32_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const uistring lhs,
const char32_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( char32_t  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( const char32_t *  lhs,
const uistring rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
wchar_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
const wchar_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
char16_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
const char16_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
char32_t  rhs 
)
inline

Concatenates two strings or the string and the character.

uistring boost::ui::operator+ ( uistring &&  lhs,
const char32_t *  rhs 
)
inline

Concatenates two strings or the string and the character.

template<class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< ( std::basic_ostream< CharT, Traits > &  os,
const boost::ui::color c 
)

Writes color into the stream.

template<class Traits >
std::basic_ostream< char, Traits > & operator<< ( std::basic_ostream< char, Traits > &  os,
const uistring str 
)

Writes string into the stream.

template<class Traits >
std::basic_ostream<char32_t, Traits>& boost::ui::operator<< ( std::basic_ostream< char32_t, Traits > &  os,
const uistring str 
)

Writes string into the stream.

template<class Traits >
std::basic_ostream<char16_t, Traits>& boost::ui::operator<< ( std::basic_ostream< char16_t, Traits > &  os,
const uistring str 
)

Writes string into the stream.

template<class Traits >
std::basic_ostream<wchar_t, Traits>& boost::ui::operator<< ( std::basic_ostream< wchar_t, Traits > &  os,
const uistring str 
)

Writes string into the stream.

template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< ( std::basic_ostream< CharT, Traits > &  os,
const basic_size< T > &  p 
)

Writes basic_size into basic_size stream.

template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< ( std::basic_ostream< CharT, Traits > &  os,
const basic_point< T > &  p 
)

Writes basic_point into the stream.

template<class T , class CharT , class Traits >
std::basic_ostream< CharT, Traits > & operator<< ( std::basic_ostream< CharT, Traits > &  os,
const basic_rect< T > &  r 
)

Writes basic_rect into the stream.

bool operator== ( const color lhs,
const color rhs 
)
inlinenoexcept

Compares two colors.

Examples:
sort.cpp.
template<class Traits >
std::basic_istream< char, Traits > & operator>> ( std::basic_istream< char, Traits > &  is,
ui::uistring str 
)

Reads string from the stream.

template<class Traits >
std::basic_istream<wchar_t, Traits>& boost::ui::operator>> ( std::basic_istream< wchar_t, Traits > &  is,
ui::uistring str 
)

Reads string from the stream.

template<class Traits >
std::basic_istream<char16_t, Traits>& boost::ui::operator>> ( std::basic_istream< char16_t, Traits > &  is,
ui::uistring str 
)

Reads string from the stream.

template<class Traits >
std::basic_istream<char32_t, Traits>& boost::ui::operator>> ( std::basic_istream< char32_t, Traits > &  is,
ui::uistring str 
)

Reads string from the stream.

uistring to_uistring ( int  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( unsigned int  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( long  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( unsigned long  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( long long  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( unsigned long long  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( float  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( double  value)

Converts numeric value to uistring.

uistring boost::ui::to_uistring ( long double  value)

Converts numeric value to uistring.

uistring u8uistring ( const char *  str)
inline

Constructs uistring from UTF-8 encoded string.

uistring boost::ui::u8uistring ( const std::string &  str)
inline

Constructs uistring from UTF-8 encoded string.

uistring boost::ui::utf8 ( const char *  str)
inline

Constructs uistring from UTF-8 encoded string.

Examples:
asio_chat_client.cpp, and locale.cpp.
uistring boost::ui::utf8 ( const std::string &  str)
inline

Constructs uistring from UTF-8 encoded string.