doxy comments, void form::div(std::string div_text);

This commit is contained in:
qPCR4vir 2019-12-06 01:27:58 +01:00
parent 0345d503ba
commit f88224766d
3 changed files with 23 additions and 16 deletions

View File

@ -395,7 +395,7 @@ namespace API
/// Blocks the execution and other windows' messages until the specified window is closed. /// Blocks the execution and other windows' messages until the specified window is closed.
void modal_window(window); void modal_window(window);
/// Blocks the execution until the specified window is closesd. /// Blocks the execution until the specified window is closed.
void wait_for(window); void wait_for(window);
color fgcolor(window); color fgcolor(window);

View File

@ -1,13 +1,13 @@
/** /**
* A Form Implementation * A Form Implementation
* Nana C++ Library(http://www.nanapro.org) * Nana C++ Library(http://www.nanapro.org)
* Copyright(C) 2003-2018 Jinhao(cnjinhao@hotmail.com) * Copyright(C) 2003-2019 Jinhao(cnjinhao@hotmail.com)
* *
* Distributed under the Boost Software License, Version 1.0. * Distributed under the Boost Software License, Version 1.0.
* (See accompanying file LICENSE_1_0.txt or copy at * (See accompanying file LICENSE_1_0.txt or copy at
* http://www.boost.org/LICENSE_1_0.txt) * http://www.boost.org/LICENSE_1_0.txt)
* *
* @file: nana/gui/widgets/form.hpp * @file nana/gui/widgets/form.hpp
*/ */
#ifndef NANA_GUI_WIDGET_FORM_HPP #ifndef NANA_GUI_WIDGET_FORM_HPP
@ -42,7 +42,7 @@ namespace nana
//place methods //place methods
place & get_place(); place & get_place();
void div(const char* div_text); void div(std::string div_text);
place::field_reference operator[](const char* field_name); place::field_reference operator[](const char* field_name);
void collocate() noexcept; void collocate() noexcept;
private: private:
@ -51,23 +51,30 @@ namespace nana
}//end namespace form }//end namespace form
}//end namespace drawerbase }//end namespace drawerbase
/// \brief Pop-up window. Is different from other window widgets: its default constructor creates the window. /// The form widget represents a popup window.
///
/// Overall it is a root widget (\see: Overview of widgets) which attaches the OS/Windowing system's native window.
/// It is different from other window widgets in that its default constructor creates the window.
/// \see nana::appearance /// \see nana::appearance
class form class form
: public drawerbase::form::form_base : public drawerbase::form::form_base
{ {
public: public:
/// helper template class for creating the appearance of the form.
using appear = ::nana::appear; using appear = ::nana::appear;
/// Creates a window at the point and size specified by rect, and with the specified appearance. Creates a form owned by the desktop. /// Creates a window form owned by the desktop, at the point and size specified by rect, and with the specified appearance.
form(const rectangle& = API::make_center(300, 200), const appearance& = {}); //Default constructor explicit form(const rectangle& = API::make_center(300, 200), const appearance& = {}); //Default constructor
form(const form&, const ::nana::size& = { 300, 200 }, const appearance& = {}); //Copy constructor /// Creates a window always floating above its owner at the point and size specified by rect, with the specified appearance. This window is always floating above its owner.
form(window, const ::nana::size& = { 300, 200 }, const appearance& = {}); explicit form(window owner, const ::nana::size& = { 300, 200 }, const appearance& = {});
/// Creates a window at the point and size specified by rect, with the specified appearance. This window is always floating above its owner. explicit form(window owner, const rectangle&, const appearance& = {});
form(window, const rectangle&, const appearance& = {}); form(const form&, const ::nana::size& = { 300, 200 }, const appearance& = {}); //Copy constructor
void modality() const; /// Blocks the execution and other windows' messages until this window is closed.
void wait_for_this(); void modality() const;
/// Blocks the execution until this window is closed.
void wait_for_this();
void keyboard_accelerator(const accel_key&, const std::function<void()>& fn); void keyboard_accelerator(const accel_key&, const std::function<void()>& fn);
}; };

View File

@ -39,7 +39,7 @@ namespace nana
place & form_base::get_place() place & form_base::get_place()
{ {
if (this->empty()) if (this->empty())
throw std::runtime_error("form::get_plac: the form has destroyed."); throw std::runtime_error("form::get_place(): the form has been destroyed.");
if (!place_) if (!place_)
place_.reset(new place{ *this }); place_.reset(new place{ *this });
@ -47,9 +47,9 @@ namespace nana
return *place_; return *place_;
} }
void form_base::div(const char* div_text) void form_base::div(std::string div_text)
{ {
get_place().div(div_text); get_place().div(std::move(div_text));
} }
place::field_reference form_base::operator[](const char* field_name) place::field_reference form_base::operator[](const char* field_name)