xtd.forms - Reference Guide  0.1.0
Modern c++17 library containing classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and Linux like Ubuntu operating system.
xtd::forms::about_dialog Class Referencefinal

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

#include <about_dialog.h>

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...
 

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.forms>
#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());
}

Constructor & Destructor Documentation

§ about_dialog()

xtd::forms::about_dialog::about_dialog ( )
default

Initializes a new instance of the about_dialog class.

Member Function Documentation

§ copyright() [1/2]

std::string xtd::forms::about_dialog::copyright ( ) const
inline

Gets the product copyright.

Returns
The product copyright.

§ copyright() [2/2]

about_dialog& xtd::forms::about_dialog::copyright ( const std::string &  copyright)
inline

Sets the product description.

Parameters
copyrightThe description copyright.
Returns
Current about_dialog instance.

§ creators() [1/3]

const creators_collection& xtd::forms::about_dialog::creators ( ) const
inline

Gets the creators array.

Returns
The creator array.

§ creators() [2/3]

creators_collection& xtd::forms::about_dialog::creators ( )
inline

Gets the creators array.

Returns
The creator array.

§ creators() [3/3]

about_dialog& xtd::forms::about_dialog::creators ( const creators_collection creators)
inline

Sets the creators array.

Parameters
creatorsThe creators array.
Returns
Current about_dialog instance.

§ description() [1/2]

std::string xtd::forms::about_dialog::description ( ) const
inline

Gets the product description.

Returns
The product description.

§ description() [2/2]

about_dialog& xtd::forms::about_dialog::description ( const std::string &  description)
inline

Sets the product description.

Parameters
descriptionThe product description.
Returns
Current about_dialog instance.

§ designers() [1/3]

const designers_collection& xtd::forms::about_dialog::designers ( ) const
inline

Gets the designers array.

Returns
The designers array.

§ designers() [2/3]

designers_collection& xtd::forms::about_dialog::designers ( )
inline

Gets the designers array.

Returns
The designers array.

§ designers() [3/3]

about_dialog& xtd::forms::about_dialog::designers ( const designers_collection designers)
inline

Sets the designers array.

Parameters
designersThe designers array.
Returns
Current about_dialog instance.

§ doc_writers() [1/3]

const doc_writers_collection& xtd::forms::about_dialog::doc_writers ( ) const
inline

Gets the documentation writers array.

Returns
The documentation writers array.

§ doc_writers() [2/3]

doc_writers_collection& xtd::forms::about_dialog::doc_writers ( )
inline

Gets the documentation writers array.

Returns
The designers array.

§ doc_writers() [3/3]

about_dialog& xtd::forms::about_dialog::doc_writers ( const doc_writers_collection doc_writers)
inline

Sets the documentation writers array.

Parameters
doc_writersThe documentation writers array.
Returns
Current about_dialog instance.

§ icon() [1/4]

xtd::drawing::icon xtd::forms::about_dialog::icon ( ) const
inline

Gets the product icon.

Returns
The product icon.

§ icon() [2/4]

about_dialog& xtd::forms::about_dialog::icon ( const xtd::drawing::icon icon)
inline

Sets the product icon.

Parameters
iconThe product icon.
Returns
Current about_dialog instance.

§ icon() [3/4]

about_dialog& xtd::forms::about_dialog::icon ( const xtd::drawing::image image)
inline

Sets the product icon.

Parameters
imageThe product icon.
Returns
Current about_dialog instance.

§ icon() [4/4]

about_dialog& xtd::forms::about_dialog::icon ( const xtd::drawing::bitmap bitmap)
inline

Sets the product icon.

Parameters
bitmapThe product icon.
Returns
Current about_dialog instance.

§ license() [1/2]

std::string xtd::forms::about_dialog::license ( ) const
inline

Gets the product license.

Returns
The product license.

§ license() [2/2]

about_dialog& xtd::forms::about_dialog::license ( const std::string &  license)
inline

Sets the product license.

Parameters
nameThe product license.
Returns
Current about_dialog instance.

§ long_version() [1/2]

std::string xtd::forms::about_dialog::long_version ( ) const
inline

Gets the product long version.

Returns
The product long version.

§ long_version() [2/2]

about_dialog& xtd::forms::about_dialog::long_version ( const std::string &  long_version)
inline

Sets the product long version.

Parameters
versionThe version version.
Returns
Current about_dialog instance.

§ name() [1/2]

std::string xtd::forms::about_dialog::name ( ) const
inline

Gets the product name.

Returns
The product name.

§ name() [2/2]

about_dialog& xtd::forms::about_dialog::name ( const std::string &  name)
inline

Sets the product name.

Parameters
nameThe product name.
Returns
Current about_dialog instance.

§ reset()

void xtd::forms::about_dialog::reset ( )

Resets all properties to empty string.

§ show() [1/2]

void xtd::forms::about_dialog::show ( )

Runs about dialog box.

§ show() [2/2]

void xtd::forms::about_dialog::show ( const iwin32_window owner)

Runs about dialog box.

§ translators() [1/3]

const translators_collection& xtd::forms::about_dialog::translators ( ) const
inline

Gets the translators array.

Returns
The translators array.

§ translators() [2/3]

translators_collection& xtd::forms::about_dialog::translators ( )
inline

Gets the translators array.

Returns
The translators array.

§ translators() [3/3]

about_dialog& xtd::forms::about_dialog::translators ( const translators_collection translators)
inline

Sets the translators array.

Parameters
translatorsThe translators array.
Returns
Current about_dialog instance.

§ version() [1/2]

std::string xtd::forms::about_dialog::version ( ) const
inline

Gets the product version.

Returns
The product version.

§ version() [2/2]

about_dialog& xtd::forms::about_dialog::version ( const std::string &  version)
inline

Sets the product version.

Parameters
versionThe version version.
Returns
Current about_dialog instance.

§ website() [1/2]

std::string xtd::forms::about_dialog::website ( ) const
inline

Gets the product website.

Returns
The website.

§ website() [2/2]

about_dialog& xtd::forms::about_dialog::website ( const std::string &  website)
inline

Sets the product website.

Parameters
websiteThe product website.
Returns
Current about_dialog instance.

§ website_label() [1/2]

std::string xtd::forms::about_dialog::website_label ( ) const
inline

Gets the product website label.

Returns
The product website label.

§ website_label() [2/2]

about_dialog& xtd::forms::about_dialog::website_label ( const std::string &  website_label)
inline

Sets the product website label.

Parameters
website_labelThe product website label.
Returns
Current about_dialog instance.

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