xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
xtd::forms::about_dialog Class Referencefinal

Represents a common dialog box that displays about box. More...

#include <about_dialog.h>

Inheritance diagram for xtd::forms::about_dialog:
xtd::forms::component

Public Types

using creators_collection = xtd::forms::layout::arranged_element_collection< std::string >
 
using designers_collection = xtd::forms::layout::arranged_element_collection< std::string >
 
using doc_writers_collection = xtd::forms::layout::arranged_element_collection< std::string >
 
using translators_collection = xtd::forms::layout::arranged_element_collection< std::string >
 

Public Member Functions

 about_dialog ()=default
 Initializes a new instance of the about_dialog class. More...
 
std::string copyright () const
 Gets the product copyright. More...
 
about_dialogcopyright (const std::string &copyright)
 Sets the product description. More...
 
const creators_collectioncreators () const
 Gets the creators array. More...
 
creators_collectioncreators ()
 Gets the creators array. More...
 
about_dialogcreators (const creators_collection &creators)
 Sets the creators array. More...
 
std::string description () const
 Gets the product description. More...
 
about_dialogdescription (const std::string &description)
 Sets the product description. More...
 
const designers_collectiondesigners () const
 Gets the designers array. More...
 
designers_collectiondesigners ()
 Gets the designers array. More...
 
about_dialogdesigners (const designers_collection &designers)
 Sets the designers array. More...
 
xtd::forms::dialog_style dialog_style () const
 
about_dialogdialog_style (xtd::forms::dialog_style dialog_style)
 
const doc_writers_collectiondoc_writers () const
 Gets the documentation writers array. More...
 
doc_writers_collectiondoc_writers ()
 Gets the documentation writers array. More...
 
about_dialogdoc_writers (const doc_writers_collection &doc_writers)
 Sets the documentation writers array. More...
 
xtd::drawing::icon icon () const
 Gets the product icon. More...
 
about_dialogicon (const xtd::drawing::icon &icon)
 Sets the product icon. More...
 
about_dialogicon (const xtd::drawing::image &image)
 Sets the product icon. More...
 
about_dialogicon (const xtd::drawing::bitmap &bitmap)
 Sets the product icon. More...
 
std::string license () const
 Gets the product license. More...
 
about_dialoglicense (const std::string &license)
 Sets the product license. More...
 
std::string long_version () const
 Gets the product long version. More...
 
about_dialoglong_version (const std::string &long_version)
 Sets the product long version. More...
 
std::string name () const
 Gets the product name. More...
 
about_dialogname (const std::string &name)
 Sets the product name. More...
 
void reset ()
 Resets all properties to empty string. More...
 
void show ()
 Runs about dialog box. More...
 
void show (const iwin32_window &owner)
 Runs about dialog box. More...
 
const translators_collectiontranslators () const
 Gets the translators array. More...
 
translators_collectiontranslators ()
 Gets the translators array. More...
 
about_dialogtranslators (const translators_collection &translators)
 Sets the translators array. More...
 
std::string version () const
 Gets the product version. More...
 
about_dialogversion (const std::string &version)
 Sets the product version. More...
 
std::string website () const
 Gets the product website. More...
 
about_dialogwebsite (const std::string &website)
 Sets the product website. More...
 
std::string website_label () const
 Gets the product website label. More...
 
about_dialogwebsite_label (const std::string &website_label)
 Sets the product website label. More...
 

Protected Member Functions

virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Detailed Description

Represents a common dialog box that displays about box.

Example
The following code example demonstrate the use of about_dialog dialog.
#include <xtd/xtd>
#include "../resources/gammasoft_64x64.xpm"
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
text("About dialog example");
controls().push_back(button1);
button1.location({10, 10});
button1.text("About...");
button1.click += [&] {
about_dialog.icon(xtd::drawing::bitmap(gammasoft_64x64_xpm));
about_dialog.name("About dialog");
about_dialog.version("1.0");
about_dialog.long_version("1.0.0");
about_dialog.description("About dialog description.");
about_dialog.copyright("Copyright (c) 2020 Gammasoft.\nAll rights reserved.");
about_dialog.website("https://gammasoft71.wixsite.com/gammasoft");
about_dialog.website_label("gammasoft website");
about_dialog.creators({"Gammasoft", "Contributors"});
about_dialog.doc_writers({"Gammasoft"});
about_dialog.translators({"Gammasoft", "Contributors"});
about_dialog.designers({"Gammasoft"});
about_dialog.license("MIT License\n"
"\n"
"Copyright (c) 2019 Gammasoft.\n"
"\n"
"Permission is hereby granted, free of charge, to any person obtaining\n"
"a copy of this software and associated documentation files (the\n"
"\"Software\"), to deal in the Software without restriction, including\n"
"without limitation the rights to use, copy, modify, merge, publish,\n"
"distribute, sublicense, and/or sell copies of the Software, and to\n"
"permit persons to whom the Software is furnished to do so, subject\n"
"to the following conditions:\n"
"\n"
"The above copyright notice and this permission notice shall be\n"
"included in all copies or substantial portions of the Software.\n"
"\n"
"THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF\n"
"ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO\n"
"THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A\n"
"PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\n"
"SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR\n"
"ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\n"
"ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n"
"OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE\n"
"OR OTHER DEALINGS IN THE SOFTWARE.\n");
about_dialog.show();
};
}
private:
};
int main() {
application::run(form1());
}

The documentation for this class was generated from the following file: