mirror of https://github.com/KLayout/klayout.git
WIP: wording.
This commit is contained in:
Matthias Koefferlein
parent
4782450170
commit
8a95b2e6f7
|
|
@ -123,25 +123,25 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
|
|||
"This method has been introduced in version 0.26."
|
||||
) +
|
||||
method ("action", (lay::Action *(lay::AbstractMenu::*) (const std::string &path)) &lay::AbstractMenu::action, gsi::arg ("path"),
|
||||
"@brief Get the reference to a Action object associated with the given path\n"
|
||||
"@brief Gets the reference to a Action object associated with the given path\n"
|
||||
"\n"
|
||||
"@param path The path to the item.\n"
|
||||
"@return A reference to a Action object associated with this path or nil if the path is not valid\n"
|
||||
) +
|
||||
method ("items", &lay::AbstractMenu::items, gsi::arg ("path"),
|
||||
"@brief Get the subitems for a given submenu\n"
|
||||
"@brief Gets the subitems for a given submenu\n"
|
||||
"\n"
|
||||
"@param path The path to the submenu\n"
|
||||
"@return A vector or path strings for the child items or an empty vector if the path is not valid or the item does not have children\n"
|
||||
) +
|
||||
method ("is_menu?", &lay::AbstractMenu::is_menu, gsi::arg ("path"),
|
||||
"@brief Query if an item is a menu\n"
|
||||
"@brief Returns true if the item is a menu\n"
|
||||
"\n"
|
||||
"@param path The path to the item\n"
|
||||
"@return false if the path is not valid or is not a menu\n"
|
||||
) +
|
||||
method ("is_separator?", &lay::AbstractMenu::is_separator, gsi::arg ("path"),
|
||||
"@brief Query if an item is a separator\n"
|
||||
"@brief Returns true if the item is a separator\n"
|
||||
"\n"
|
||||
"@param path The path to the item\n"
|
||||
"@return false if the path is not valid or is not a separator\n"
|
||||
|
|
@ -149,13 +149,13 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
|
|||
"This method has been introduced in version 0.19.\n"
|
||||
) +
|
||||
method ("is_valid?", &lay::AbstractMenu::is_valid, gsi::arg ("path"),
|
||||
"@brief Query if a path is a valid one\n"
|
||||
"@brief Returns true if the path is a valid one\n"
|
||||
"\n"
|
||||
"@param path The path to check\n"
|
||||
"@return false if the path is not a valid path to an item\n"
|
||||
) +
|
||||
method ("insert_item", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const lay::Action &)) &lay::AbstractMenu::insert_item, gsi::arg ("path"), gsi::arg ("name"), gsi::arg ("action"),
|
||||
"@brief Insert a new item before the one given by the path\n"
|
||||
"@brief Inserts a new item before the one given by the path\n"
|
||||
"\n"
|
||||
"The Action object passed as the third parameter references the handler which both implements the "
|
||||
"action to perform and the menu item's appearance such as title, icon and keyboard shortcut.\n"
|
||||
|
|
@ -165,13 +165,13 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
|
|||
"@param action The Action object to insert\n"
|
||||
) +
|
||||
method ("insert_separator", &lay::AbstractMenu::insert_separator, gsi::arg ("path"), gsi::arg ("name"),
|
||||
"@brief Insert a new separator before the item given by the path\n"
|
||||
"@brief Inserts a new separator before the item given by the path\n"
|
||||
"\n"
|
||||
"@param path The path to the item before which to insert the separator\n"
|
||||
"@param name The name of the separator to insert \n"
|
||||
) +
|
||||
method ("insert_menu", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const std::string &)) &lay::AbstractMenu::insert_menu, gsi::arg ("path"), gsi::arg ("name"), gsi::arg ("title"),
|
||||
"@brief Insert a new submenu before the item given by the path\n"
|
||||
"@brief Inserts a new submenu before the item given by the path\n"
|
||||
"\n"
|
||||
"The title string optionally encodes the key shortcut and icon resource\n"
|
||||
"in the form <text>[\"(\"<shortcut>\")\"][\"<\"<icon-resource>\">\"].\n"
|
||||
|
|
@ -181,17 +181,17 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
|
|||
"@param title The title of the submenu to insert\n"
|
||||
) +
|
||||
method ("delete_item", &lay::AbstractMenu::delete_item, gsi::arg ("path"),
|
||||
"@brief Delete the item given by the path\n"
|
||||
"@brief Deletes the item given by the path\n"
|
||||
"\n"
|
||||
"@param path The path to the item to delete\n"
|
||||
) +
|
||||
method ("group", &lay::AbstractMenu::group, gsi::arg ("group"),
|
||||
"@brief Get the group members\n"
|
||||
"@brief Gets the group members\n"
|
||||
"\n"
|
||||
"@param group The group name\n"
|
||||
"@param A vector of all members (by path) of the group\n"
|
||||
),
|
||||
"@brief The abstract menu class\n"
|
||||
"@brief An abstraction for the application menues\n"
|
||||
"\n"
|
||||
"The abstract menu is a class that stores a main menu and several popup menus\n"
|
||||
"in a generic form such that they can be manipulated and converted into GUI objects.\n"
|
||||
|
|
@ -310,17 +310,17 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
|
|||
"This method has been introduced in version 0.25.\n"
|
||||
) +
|
||||
method ("checkable=", &lay::Action::set_checkable, gsi::arg ("checkable"),
|
||||
"@brief Make the item(s) checkable or not\n"
|
||||
"@brief Makes the item(s) checkable or not\n"
|
||||
"\n"
|
||||
"@param checkable true to make the item checkable\n"
|
||||
) +
|
||||
method ("enabled=", &lay::Action::set_enabled, gsi::arg ("enabled"),
|
||||
"@brief Enable or disable the action\n"
|
||||
"@brief Enables or disables the action\n"
|
||||
"\n"
|
||||
"@param enabled true to enable the item\n"
|
||||
) +
|
||||
method ("visible=", &lay::Action::set_visible, gsi::arg ("visible"),
|
||||
"@brief Show or hide\n"
|
||||
"@brief Sets the item's visibility\n"
|
||||
"\n"
|
||||
"@param visible true to make the item visible\n"
|
||||
) +
|
||||
|
|
@ -331,29 +331,29 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
|
|||
"This attribute has been introduced in version 0.25\n"
|
||||
) +
|
||||
method ("checked=", &lay::Action::set_checked, gsi::arg ("checked"),
|
||||
"@brief Check or uncheck\n"
|
||||
"@brief Checks or unchecks the item\n"
|
||||
"\n"
|
||||
"@param checked true to make the item checked\n"
|
||||
) +
|
||||
method ("icon=", &lay::Action::set_icon, gsi::arg ("file"),
|
||||
"@brief Set the icon to the given picture\n"
|
||||
"@brief Sets the icon to the given image file\n"
|
||||
"\n"
|
||||
"@param file The image file to load for the icon\n"
|
||||
"\n"
|
||||
"Passing an empty string will reset the icon\n"
|
||||
"Passing an empty string will reset the icon.\n"
|
||||
) +
|
||||
method ("icon_text=", &lay::Action::set_icon_text, gsi::arg ("icon_text"),
|
||||
"@brief Set the icon's text \n"
|
||||
"@brief Sets the icon's text\n"
|
||||
"\n"
|
||||
"If an icon text is set, this will be used for the text below the icon.\n"
|
||||
"If no icon text is set, the normal text will be used for the icon.\n"
|
||||
"Passing an empty string will reset the icon's text.\n"
|
||||
) +
|
||||
method ("icon_text", &lay::Action::get_icon_text,
|
||||
"@brief Get the icon's text\n"
|
||||
"@brief Gets the icon's text\n"
|
||||
) +
|
||||
method ("tool_tip=", &lay::Action::set_tool_tip, gsi::arg ("text"),
|
||||
"@brief Set the tool tip text \n"
|
||||
"@brief Sets the tool tip text\n"
|
||||
"\n"
|
||||
"The tool tip text is displayed in the tool tip window of the menu entry.\n"
|
||||
"This is in particular useful for entries in the tool bar."
|
||||
|
|
@ -361,12 +361,12 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
|
|||
"This method has been added in version 0.22.\n"
|
||||
) +
|
||||
method ("tool_tip", &lay::Action::get_tool_tip,
|
||||
"@brief Get the tool tip text\n"
|
||||
"@brief Gets the tool tip text.\n"
|
||||
"\n"
|
||||
"This method has been added in version 0.22.\n"
|
||||
) +
|
||||
method ("trigger", &lay::Action::trigger,
|
||||
"@brief Trigger the action programmatically"
|
||||
"@brief Triggers the action programmatically"
|
||||
),
|
||||
"@hide\n"
|
||||
"@alias Action\n"
|
||||
|
|
|
|||
Loading…
Reference in New Issue