luke/klayout
1
0
Fork 0
mirror of https://github.com/KLayout/klayout.git synced 2026-09-08 04:08:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Got rid of most of the @args

Browse Source
This commit is contained in:
Matthias Koefferlein
2020-03-14 21:50:47 +01:00
parent 415a1a97f9
commit 53c81cc572
40 changed files with 888 additions and 1825 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/laybasic/laybasic/gsiDeclLayDialogs.cc
+47 -95
View File
@@ -277,25 +277,21 @@ BrowserDialog_Stub *new_browser_dialog_static_and_parent (QWidget *parent, const
#endif
Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay", "BrowserDialog",
gsi::constructor ("new", &new_browser_dialog_with_source,
gsi::constructor ("new", &new_browser_dialog_with_source, gsi::arg ("source"),
"@brief Creates a HTML browser window with a \\BrowserSource as the source of HTML code\n"
"@args source\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_browser_dialog_static,
gsi::constructor ("new", &new_browser_dialog_static, gsi::arg ("html"),
"@brief Creates a HTML browser window with a static HTML content\n"
"@args html\n"
"This method has been introduced in version 0.23.\n"
) +
#if defined(HAVE_QTBINDINGS)
gsi::constructor ("new", &new_browser_dialog_with_source_and_parent,
gsi::constructor ("new", &new_browser_dialog_with_source_and_parent, gsi::arg ("parent"), gsi::arg ("source"),
"@brief Creates a HTML browser window with a \\BrowserSource as the source of HTML code\n"
"@args parent,source\n"
"This method variant with a parent argument has been introduced in version 0.24.2.\n"
) +
gsi::constructor ("new", &new_browser_dialog_static_and_parent,
gsi::constructor ("new", &new_browser_dialog_static_and_parent, gsi::arg ("parent"), gsi::arg ("html"),
"@brief Creates a HTML browser window with a static HTML content\n"
"@args parent,html\n"
"This method variant with a parent argument has been introduced in version 0.24.2.\n"
) +
#else
@@ -309,24 +305,21 @@ Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay",
gsi::method ("execute|#exec", &BrowserDialog_Stub::exec,
"@brief Executes the HTML browser dialog as a modal window\n"
) +
gsi::method ("load", &BrowserDialog_Stub::load,
gsi::method ("load", &BrowserDialog_Stub::load, gsi::arg ("url"),
"@brief Loads the given URL into the browser dialog\n"
"@args url\n"
"Typically the URL has the \"int:\" scheme so the HTML code is taken from the "
"\\BrowserSource object.\n"
) +
gsi::method ("label=", &BrowserDialog_Stub::set_label,
gsi::method ("label=", &BrowserDialog_Stub::set_label, gsi::arg ("label"),
"@brief Sets the label text\n"
"@args label\n"
"\n"
"The label is shown left of the navigation buttons.\n"
"By default, no label is specified.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("set_search_url", &BrowserDialog_Stub::set_search_url,
gsi::method ("set_search_url", &BrowserDialog_Stub::set_search_url, gsi::arg ("url"), gsi::arg ("query_item"),
"@brief Enables the search field and specifies the search URL generated for a search\n"
"@args url, query_item\n"
"\n"
"If a search URL is set, the search box right to the navigation bar will be enabled. "
"When a text is entered into the search box, the browser will navigate to an URL composed "
@@ -334,34 +327,29 @@ Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("search", &BrowserDialog_Stub::search,
gsi::method ("search", &BrowserDialog_Stub::search, gsi::arg ("search_item"),
"@brief Issues a search request using the given search item and the search URL specified with \\set_search_url\n"
"@args search_item\n"
"\n"
"See \\set_search_url for a description of the search mechanism.\n"
) +
gsi::method_ext ("source=|#set_source", &set_source,
gsi::method_ext ("source=|#set_source", &set_source, gsi::arg ("source"),
"@brief Connects to a source object\n"
"@args source\n"
"\n"
"Setting the source should be the first thing done after the BrowserDialog object is created. It will not "
"have any effect after the browser has loaded the first page. In particular, \\home= should be called after the source "
"was set."
) +
gsi::method_ext ("resize|#set_size", &set_size,
gsi::method_ext ("resize|#set_size", &set_size, gsi::arg ("width"), gsi::arg ("height"),
"@brief Sets the size of the dialog window\n"
"@args width, height\n"
) +
gsi::method_ext ("caption=|#set_caption", &set_caption,
gsi::method_ext ("caption=|#set_caption", &set_caption, gsi::arg ("caption"),
"@brief Sets the caption of the window\n"
"@args caption\n"
) +
gsi::method ("reload", &BrowserDialog_Stub::reload,
"@brief Reloads the current page"
) +
gsi::method ("home=|#set_home", &BrowserDialog_Stub::set_home,
gsi::method ("home=|#set_home", &BrowserDialog_Stub::set_home, gsi::arg ("home_url"),
"@brief Sets the browser's initial and current URL which is selected if the \"home\" location is chosen\n"
"@args home_url\n"
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
"The default location is \"int:/index.html\".\n"
) +
@@ -430,9 +418,8 @@ Class<BrowserSource_Stub> decl_BrowserSourceStub ("lay", "BrowserSource",
"\n"
"The default HTML string is sent when no specific implementation is provided.\n"
) +
gsi::callback ("get", &BrowserSource_Stub::get, &BrowserSource_Stub::get_cb,
gsi::callback ("get", &BrowserSource_Stub::get, &BrowserSource_Stub::get_cb, gsi::arg ("url"),
"@brief Get the HTML code for a given \"int\" URL.\n"
"@args url\n"
"\n"
"If this method returns an empty string, the browser will not be set to \n"
"a new location. This allows implementing any functionality behind such links.\n"
@@ -463,48 +450,41 @@ lay::BrowserPanel *new_browser_panel (QWidget *parent)
}
Class<lay::BrowserPanel> decl_BrowserPanel (QT_EXTERNAL_BASE (QWidget) "lay", "BrowserPanel",
gsi::constructor ("new", &new_browser_panel_with_source,
gsi::constructor ("new", &new_browser_panel_with_source, gsi::arg ("parent"), gsi::arg ("source"),
"@brief Creates a HTML browser widget with a \\BrowserSource as the source of HTML code\n"
"@args parent, source\n"
) +
gsi::constructor ("new", &new_browser_panel,
gsi::constructor ("new", &new_browser_panel, gsi::arg ("parent"),
"@brief Creates a HTML browser widget\n"
"@args parent\n"
) +
gsi::method ("load", &lay::BrowserPanel::load,
gsi::method ("load", &lay::BrowserPanel::load, gsi::arg ("url"),
"@brief Loads the given URL into the browser widget\n"
"@args url\n"
"Typically the URL has the \"int:\" scheme so the HTML code is taken from the "
"\\BrowserSource object.\n"
) +
gsi::method ("url", &lay::BrowserPanel::url,
"@brief Gets the URL currently shown\n"
) +
gsi::method ("set_search_url", &lay::BrowserPanel::set_search_url,
gsi::method ("set_search_url", &lay::BrowserPanel::set_search_url, gsi::arg ("url"), gsi::arg ("query_item"),
"@brief Enables the search field and specifies the search URL generated for a search\n"
"@args url, query_item\n"
"\n"
"If a search URL is set, the search box right to the navigation bar will be enabled. "
"When a text is entered into the search box, the browser will navigate to an URL composed "
"of the search URL, the search item and the search text, i.e. \"myurl?item=search_text\".\n"
) +
gsi::method ("search", &lay::BrowserPanel::search,
gsi::method ("search", &lay::BrowserPanel::search, gsi::arg ("search_item"),
"@brief Issues a search request using the given search item and the search URL specified with \\set_search_url\n"
"@args search_item\n"
"\n"
"See \\search_url= for a description of the search mechanism.\n"
) +
gsi::method ("source=", &lay::BrowserPanel::set_source,
gsi::method ("source=", &lay::BrowserPanel::set_source, gsi::arg ("source"),
"@brief Connects to a source object\n"
"@args source\n"
"\n"
"Setting the source should be the first thing done after the BrowserDialog object is created. It will not "
"have any effect after the browser has loaded the first page. In particular, \\home= should be called after the source "
"was set."
) +
gsi::method ("label=", &lay::BrowserPanel::set_label,
gsi::method ("label=", &lay::BrowserPanel::set_label, gsi::arg ("label"),
"@brief Sets the label text\n"
"@args label\n"
"\n"
"The label is shown left of the navigation buttons.\n"
"By default, no label is specified.\n"
@@ -512,9 +492,8 @@ Class<lay::BrowserPanel> decl_BrowserPanel (QT_EXTERNAL_BASE (QWidget) "lay", "B
gsi::method ("reload", &lay::BrowserPanel::reload,
"@brief Reloads the current page"
) +
gsi::method ("home=", &lay::BrowserPanel::set_home,
gsi::method ("home=", &lay::BrowserPanel::set_home, gsi::arg ("home_url"),
"@brief Sets the browser widget's initial and current URL which is selected if the \"home\" location is chosen\n"
"@args home_url\n"
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
"The default location is \"int:/index.html\".\n"
),
@@ -711,18 +690,16 @@ static tl::Variant ask_item (const std::string &title, const std::string &label,
struct InputDialog { };
Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
gsi::method ("#get_string", &get_string,
gsi::method ("#get_string", &get_string, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_item", &get_item,
gsi::method ("#get_item", &get_item, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("items"), gsi::arg ("value"),
"@brief Open an input dialog requesting an item from a list\n"
"@args title, label, items, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param items The list of items to show in the selection element\n"
@@ -730,18 +707,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_string_password", &get_string_password,
gsi::method ("#get_string_password", &get_string_password, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string without showing the actual characters entered\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_double", &get_double,
gsi::method ("#get_double", &get_double, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value\n"
"@args title, label, value, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -749,9 +724,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\DoubleValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_double_ex", &get_double_ex,
gsi::method ("#get_double_ex", &get_double_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value with enhanced capabilities\n"
"@args title, label, value, min, max, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -761,18 +735,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\DoubleValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_int", &get_int,
gsi::method ("#get_int", &get_int, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting an integer value\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\IntValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_int_ex", &get_int_ex,
gsi::method ("#get_int_ex", &get_int_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("step"),
"@brief Open an input dialog requesting an integer value with enhanced capabilities\n"
"@args title, label, value, min, max, step\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -782,18 +754,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\IntValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("ask_string", &ask_string,
gsi::method ("ask_string", &ask_string, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return The string entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_item", &ask_item,
gsi::method ("ask_item", &ask_item, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("items"), gsi::arg ("value"),
"@brief Open an input dialog requesting an item from a list\n"
"@args title, label, items, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param items The list of items to show in the selection element\n"
@@ -801,18 +771,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The string of the item selected if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_string_password", &ask_string_password,
gsi::method ("ask_string_password", &ask_string_password, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string without showing the actual characters entered\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return The string entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_double", &ask_double,
gsi::method ("ask_double", &ask_double, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value\n"
"@args title, label, value, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -820,9 +788,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_double_ex", &ask_double_ex,
gsi::method ("ask_double_ex", &ask_double_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value with enhanced capabilities\n"
"@args title, label, value, min, max, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -832,9 +799,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_int", &ask_int,
gsi::method ("ask_int", &ask_int, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting an integer value\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -842,9 +808,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_int_ex", &ask_int_ex,
gsi::method ("ask_int_ex", &ask_int_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("step"),
"@brief Open an input dialog requesting an integer value with enhanced capabilities\n"
"@args title, label, value, min, max, step\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@@ -968,9 +933,8 @@ static tl::Variant ask_save_file_name (const std::string &title, const std::stri
}
Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
gsi::method ("#get_existing_dir", &get_existing_dir,
gsi::method ("#get_existing_dir", &get_existing_dir, gsi::arg ("title"), gsi::arg ("dir"),
"@brief Open a dialog to select a directory\n"
"@args title, dir\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -978,9 +942,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_existing_dir instead.\n"
) +
gsi::method ("#get_open_file_names", &get_open_file_names,
gsi::method ("#get_open_file_names", &get_open_file_names, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one or multiple files for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -989,9 +952,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_open_file_names instead.\n"
) +
gsi::method ("#get_open_file_name", &get_open_file_name,
gsi::method ("#get_open_file_name", &get_open_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1000,9 +962,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_open_file_name instead.\n"
) +
gsi::method ("#get_save_file_name", &get_save_file_name,
gsi::method ("#get_save_file_name", &get_save_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for writing\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1011,9 +972,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_save_file_name instead.\n"
) +
gsi::method ("ask_existing_dir", &ask_existing_dir,
gsi::method ("ask_existing_dir", &ask_existing_dir, gsi::arg ("title"), gsi::arg ("dir"),
"@brief Open a dialog to select a directory\n"
"@args title, dir\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1021,9 +981,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_open_file_names", &ask_open_file_names,
gsi::method ("ask_open_file_names", &ask_open_file_names, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one or multiple files for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1032,9 +991,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_open_file_name", &ask_open_file_name,
gsi::method ("ask_open_file_name", &ask_open_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1043,9 +1001,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_save_file_name", &ask_save_file_name,
gsi::method ("ask_save_file_name", &ask_save_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for writing\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@@ -1182,33 +1139,29 @@ Class<MessageBox> decl_MessageBox (QT_EXTERNAL_BASE (QMainWindow) "lay", "Messag
gsi::method ("Abort|#b_abort", &b_abort, "@brief A constant describing the 'Abort' button") +
gsi::method ("Retry|#b_retry", &b_retry, "@brief A constant describing the 'Retry' button") +
gsi::method ("Ignore|#b_ignore", &b_ignore, "@brief A constant describing the 'Ignore' button") +
gsi::method ("warning", &warning,
gsi::method ("warning", &warning, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a warning message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("question", &question,
gsi::method ("question", &question, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a question message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("info", &info,
gsi::method ("info", &info, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a information message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("critical", &critical,
gsi::method ("critical", &critical, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a critical (error) message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
@@ -1233,4 +1186,3 @@ Class<MessageBox> decl_MessageBox (QT_EXTERNAL_BASE (QMainWindow) "lay", "Messag
);
}
src/laybasic/laybasic/gsiDeclLayLayers.cc
+69 -139
View File
@@ -421,15 +421,13 @@ static std::string source_string_1 (const lay::LayerProperties *n)
}
Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("==", &lay::LayerProperties::operator==,
method ("==", &lay::LayerProperties::operator==, gsi::arg ("other"),
"@brief Equality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("!=", &lay::LayerProperties::operator!=,
method ("!=", &lay::LayerProperties::operator!=, gsi::arg ("other"),
"@brief Inequality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
@@ -443,9 +441,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22.\n"
) +
method ("eff_frame_color", &lay::LayerProperties::eff_frame_color,
method ("eff_frame_color", &lay::LayerProperties::eff_frame_color, gsi::arg ("real"),
"@brief Gets the effective frame color \n"
"@args real\n"
"\n"
"The effective frame color is computed from the frame color brightness and the\n"
"frame color.\n"
@@ -459,9 +456,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("eff_fill_color", &lay::LayerProperties::eff_fill_color,
method ("eff_fill_color", &lay::LayerProperties::eff_fill_color, gsi::arg ("real"),
"@brief Gets the effective fill color\n"
"@args real\n"
"\n"
"The effective fill color is computed from the frame color brightness and the\n"
"frame color.\n"
@@ -475,9 +471,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_color", &lay::LayerProperties::frame_color,
method ("frame_color", &lay::LayerProperties::frame_color, gsi::arg ("real"),
"@brief Gets the frame color\n"
"@args real\n"
"\n"
"This method may return an invalid color if the color is not set.\n"
"\n"
@@ -490,9 +485,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_color=", &lay::LayerProperties::set_frame_color,
method ("frame_color=", &lay::LayerProperties::set_frame_color, gsi::arg ("color"),
"@brief Sets the frame color to the given value\n"
"@args color\n"
"\n"
"The color is a 32bit value encoding the blue value in the lower 8 bits, "
"the green value in the next 8 bits and the red value in the 8 bits above that."
@@ -500,9 +494,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_frame_color", &lay::LayerProperties::clear_frame_color,
"@brief Resets the frame color \n"
) +
method ("has_frame_color?", &lay::LayerProperties::has_frame_color,
method ("has_frame_color?", &lay::LayerProperties::has_frame_color, gsi::arg ("real"),
"@brief True, if the frame color is set\n"
"@args real\n"
) +
method_ext ("has_frame_color?", &get_has_frame_color_1,
"@brief True, if the frame color is set\n"
@@ -511,9 +504,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_color", &lay::LayerProperties::fill_color,
method ("fill_color", &lay::LayerProperties::fill_color, gsi::arg ("real"),
"@brief Gets the fill color\n"
"@args real\n"
"\n"
"This method may return an invalid color if the color is not set.\n"
"\n"
@@ -526,9 +518,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_color=", &lay::LayerProperties::set_fill_color,
method ("fill_color=", &lay::LayerProperties::set_fill_color, gsi::arg ("color"),
"@brief Sets the fill color to the given value\n"
"@args color\n"
"\n"
"The color is a 32bit value encoding the blue value in the lower 8 bits, "
"the green value in the next 8 bits and the red value in the 8 bits above that."
@@ -536,9 +527,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_fill_color", &lay::LayerProperties::clear_fill_color,
"@brief Resets the fill color\n"
) +
method ("has_fill_color?", &lay::LayerProperties::has_fill_color,
method ("has_fill_color?", &lay::LayerProperties::has_fill_color, gsi::arg ("real"),
"@brief True, if the fill color is set\n"
"@args real\n"
) +
method_ext ("has_fill_color?", &get_has_fill_color_1,
"@brief True, if the fill color is set\n"
@@ -547,16 +537,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_brightness=", &lay::LayerProperties::set_frame_brightness,
method ("frame_brightness=", &lay::LayerProperties::set_frame_brightness, gsi::arg ("brightness"),
"@brief Sets the frame brightness\n"
"@args brightness\n"
"\n"
"For neutral brightness set this value to 0. For darker colors set it to a negative "
"value (down to -255), for brighter colors to a positive value (up to 255)\n"
) +
method ("frame_brightness", &lay::LayerProperties::frame_brightness,
method ("frame_brightness", &lay::LayerProperties::frame_brightness, gsi::arg ("real"),
"@brief Gets the frame brightness value\n"
"@args real\n"
"\n"
"If the brightness is not set, this method may return an invalid value\n"
"\n"
@@ -569,16 +557,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_brightness=", &lay::LayerProperties::set_fill_brightness,
method ("fill_brightness=", &lay::LayerProperties::set_fill_brightness, gsi::arg ("brightness"),
"@brief Sets the fill brightness\n"
"@args brightness\n"
"\n"
"For neutral brightness set this value to 0. For darker colors set it to a negative "
"value (down to -255), for brighter colors to a positive value (up to 255)\n"
) +
method ("fill_brightness", &lay::LayerProperties::fill_brightness,
method ("fill_brightness", &lay::LayerProperties::fill_brightness, gsi::arg ("real"),
"@brief Gets the fill brightness value\n"
"@args real\n"
"\n"
"If the brightness is not set, this method may return an invalid value\n"
"\n"
@@ -591,18 +577,16 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("dither_pattern=", &lay::LayerProperties::set_dither_pattern,
method ("dither_pattern=", &lay::LayerProperties::set_dither_pattern, gsi::arg ("index"),
"@brief Sets the dither pattern index\n"
"@args index"
"\n"
"The dither pattern index must be one of the valid indices.\n"
"The first indices are reserved for built-in pattern, the following ones are custom pattern.\n"
"Index 0 is always solid filled and 1 is always the hollow filled pattern.\n"
"For custom pattern see \\LayoutView#add_stipple.\n"
) +
method ("eff_dither_pattern", &lay::LayerProperties::eff_dither_pattern,
method ("eff_dither_pattern", &lay::LayerProperties::eff_dither_pattern, gsi::arg ("real"),
"@brief Gets the effective dither pattern index\n"
"@args real\n"
"\n"
"The effective dither pattern index is always a valid index, even if no dither pattern "
"is set."
@@ -616,9 +600,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("dither_pattern", &lay::LayerProperties::dither_pattern,
method ("dither_pattern", &lay::LayerProperties::dither_pattern, gsi::arg ("real"),
"@brief Gets the dither pattern index\n"
"@args real\n"
"\n"
"This method may deliver an invalid dither pattern index if it is not set.\n"
"\n"
@@ -634,9 +617,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_dither_pattern", &lay::LayerProperties::clear_dither_pattern,
"@brief Clears the dither pattern\n"
) +
method ("has_dither_pattern?", &lay::LayerProperties::has_dither_pattern,
method ("has_dither_pattern?", &lay::LayerProperties::has_dither_pattern, gsi::arg ("real"),
"@brief True, if the dither pattern is set\n"
"@args real\n"
) +
method_ext ("has_dither_pattern?", &get_has_dither_pattern_1,
"@brief True, if the dither pattern is set\n"
@@ -705,13 +687,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.25."
) +
method ("valid=", &lay::LayerProperties::set_valid,
method ("valid=", &lay::LayerProperties::set_valid, gsi::arg ("valid"),
"@brief Sets the validity state\n"
"@args valid"
) +
method ("valid?", &lay::LayerProperties::valid,
method ("valid?", &lay::LayerProperties::valid, gsi::arg ("real"),
"@brief Gets the validity state\n"
"@args real\n"
) +
method_ext ("valid?", &get_valid_1,
"@brief Gets the validity state\n"
@@ -720,13 +700,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.23."
) +
method ("visible=", &lay::LayerProperties::set_visible,
method ("visible=", &lay::LayerProperties::set_visible, gsi::arg ("visible"),
"@brief Sets the visibility state\n"
"@args visible"
) +
method ("visible?", &lay::LayerProperties::visible,
method ("visible?", &lay::LayerProperties::visible, gsi::arg ("real"),
"@brief Gets the visibility state\n"
"@args real\n"
) +
method_ext ("visible?", &get_visible_1,
"@brief Gets the visibility state\n"
@@ -735,13 +713,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("transparent=", &lay::LayerProperties::set_transparent,
method ("transparent=", &lay::LayerProperties::set_transparent, gsi::arg ("transparent"),
"@brief Sets the transparency state\n"
"@args transparent"
) +
method ("transparent?", &lay::LayerProperties::transparent,
method ("transparent?", &lay::LayerProperties::transparent, gsi::arg ("real"),
"@brief Gets the transparency state\n"
"@args real\n"
) +
method_ext ("transparent?", &get_transparent_1,
"@brief Gets the transparency state\n"
@@ -750,13 +726,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("width=", &lay::LayerProperties::set_width,
method ("width=", &lay::LayerProperties::set_width, gsi::arg ("width"),
"@brief Sets the line width to the given width\n"
"@args width"
) +
method ("width", &lay::LayerProperties::width,
method ("width", &lay::LayerProperties::width, gsi::arg ("real"),
"@brief Gets the line width\n"
"@args real\n"
) +
method_ext ("width", &get_width_1,
"@brief Gets the line width\n"
@@ -765,13 +739,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("marked=", &lay::LayerProperties::set_marked,
method ("marked=", &lay::LayerProperties::set_marked, gsi::arg ("marked"),
"@brief Sets the marked state\n"
"@args marked"
) +
method ("marked?", &lay::LayerProperties::marked,
method ("marked?", &lay::LayerProperties::marked, gsi::arg ("real"),
"@brief Gets the marked state\n"
"@args real\n"
) +
method_ext ("marked?", &get_marked_1,
"@brief Gets the marked state\n"
@@ -780,15 +752,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("xfill=", &lay::LayerProperties::set_xfill,
method ("xfill=", &lay::LayerProperties::set_xfill, gsi::arg ("xfill"),
"@brief Sets a value indicating whether shapes are drawn with a cross\n"
"@args xfill\n"
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("xfill?", &lay::LayerProperties::xfill,
method ("xfill?", &lay::LayerProperties::xfill, gsi::arg ("real"),
"@brief Gets a value indicating whether shapes are drawn with a cross\n"
"@args real\n"
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
@@ -799,15 +769,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("animation=", &lay::LayerProperties::set_animation,
method ("animation=", &lay::LayerProperties::set_animation, gsi::arg ("animation"),
"@brief Sets the animation state\n"
"@args animation\n"
"\n"
"See the description of the \\animation method for details about the animation state"
) +
method ("animation", &lay::LayerProperties::animation,
method ("animation", &lay::LayerProperties::animation, gsi::arg ("real"),
"@brief Gets the animation state\n"
"@args real\n"
"\n"
"The animation state is an integer either being 0 (static), 1 (scrolling), 2 (blinking) "
"or 3 (inversely blinking)"
@@ -819,16 +787,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("name=", &lay::LayerProperties::set_name,
method ("name=", &lay::LayerProperties::set_name, gsi::arg ("name"),
"@brief Sets the name to the given string\n"
"@args name\n"
) +
method ("name", &lay::LayerProperties::name,
"@brief Gets the name\n"
) +
method_ext ("trans", &get_trans,
method_ext ("trans", &get_trans, gsi::arg ("real"),
"@brief Gets the transformations that the layer is transformed with\n"
"@args real\n"
"\n"
"The transformations returned by this accessor is the one used for displaying this layer. "
"The layout is transformed with each of these transformations before it is drawn.\n\n"
@@ -841,15 +807,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("trans=", &set_trans,
method_ext ("trans=", &set_trans, gsi::arg ("trans_vector"),
"@brief Sets the transformations that the layer is transformed with\n"
"@args trans_vector\n"
"\n"
"See \\trans for a description of the transformations."
) +
method_ext ("source_cellview", &get_cellview,
method_ext ("source_cellview", &get_cellview, gsi::arg ("real"),
"@brief Gets the cellview index that this layer refers to\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@@ -860,15 +824,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_cellview=", &set_cellview,
method_ext ("source_cellview=", &set_cellview, gsi::arg ("cellview_index"),
"@brief Sets the cellview index that this layer refers to\n"
"@args cellview_index\n"
"\n"
"See \\cellview for a description of the transformations."
) +
method_ext ("source_layer_index", &get_layer_index,
method_ext ("source_layer_index", &get_layer_index, gsi::arg ("real"),
"@brief Gets the layer index that the shapes are taken from\n"
"@args real\n"
"\n"
"If the layer index is positive, the shapes drawn are taken from this layer rather than "
"searched for by layer and datatype. This property is stronger than the layer/datatype or "
@@ -885,15 +847,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_layer_index=", &set_layer_index,
method_ext ("source_layer_index=", &set_layer_index, gsi::arg ("index"),
"@brief Sets the layer index specification that the shapes are taken from\n"
"@args index\n"
"\n"
"See \\source_layer_index for a description of this property."
) +
method_ext ("source_layer", &get_layer,
method_ext ("source_layer", &get_layer, gsi::arg ("real"),
"@brief Gets the stream layer that the shapes are taken from\n"
"@args real\n"
"\n"
"If the layer is positive, the actual layer is looked up by this stream layer. If a name or "
"layer index is specified, the stream layer is not used.\n\n"
@@ -906,15 +866,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_layer=", &set_layer,
method_ext ("source_layer=", &set_layer, gsi::arg ("layer"),
"@brief Sets the stream layer that the shapes are taken from\n"
"@args layer\n"
"\n"
"See \\source_layer for a description of this property"
) +
method_ext ("source_datatype", &get_datatype,
method_ext ("source_datatype", &get_datatype, gsi::arg ("real"),
"@brief Gets the stream datatype that the shapes are taken from\n"
"@args real\n"
"\n"
"If the datatype is positive, the actual layer is looked up by this stream datatype. If a name or "
"layer index is specified, the stream datatype is not used.\n\n"
@@ -927,18 +885,16 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_datatype=", &set_datatype,
method_ext ("source_datatype=", &set_datatype, gsi::arg ("datatype"),
"@brief Sets the stream datatype that the shapes are taken from\n"
"@args datatype\n"
"\n"
"See \\datatype for a description of this property"
) +
method_ext ("clear_source_name", &clear_name,
"@brief Removes any stream layer name specification from this layer\n"
) +
method_ext ("source_name", &get_name,
method_ext ("source_name", &get_name, gsi::arg ("real"),
"@brief Gets the stream name that the shapes are taken from\n"
"@args real\n"
"\n"
"If the name is non-empty, the actual layer is looked up by this stream layer name. If a "
"layer index (see \\layer_index) is specified, the stream datatype is not used.\n"
@@ -952,9 +908,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("has_source_name?", &has_name,
method_ext ("has_source_name?", &has_name, gsi::arg ("real"),
"@brief Gets a value indicating whether a stream layer name is specified for this layer\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@@ -965,15 +920,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_name=", &set_name,
method_ext ("source_name=", &set_name, gsi::arg ("name"),
"@brief Sets the stream layer name that the shapes are taken from\n"
"@args name\n"
"\n"
"See \\name for a description of this property"
) +
method_ext ("upper_hier_level", &get_upper_hier_level,
method_ext ("upper_hier_level", &get_upper_hier_level, gsi::arg ("real"),
"@brief Gets the upper hierarchy level shown\n"
"@args real\n"
"\n"
"This is the hierarchy level at which the drawing starts. "
"This property is only meaningful, if \\has_upper_hier_level is true. "
@@ -988,9 +941,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level_relative?|#upper_hier_level_relative", &get_upper_hier_level_relative,
method_ext ("upper_hier_level_relative?|#upper_hier_level_relative", &get_upper_hier_level_relative, gsi::arg ("real"),
"@brief Gets a value indicating whether if the upper hierarchy level is relative.\n"
"@args real\n"
"\n"
"See \\upper_hier_level for a description of this property.\n"
"\n"
@@ -1003,9 +955,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level_mode", &get_upper_hier_level_mode,
method_ext ("upper_hier_level_mode", &get_upper_hier_level_mode, gsi::arg ("real"),
"@brief Gets the mode for the upper hierarchy level.\n"
"@args real\n"
"@param real If true, the computed value is returned, otherwise the local node value\n"
"\n"
"The mode value can be 0 (value is given by \\upper_hier_level), 1 for \"minimum value\" and 2 for \"maximum value\".\n"
@@ -1019,34 +970,30 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level=", &set_upper_hier_level1,
method_ext ("upper_hier_level=", &set_upper_hier_level1, gsi::arg ("level"),
"@brief Sets a upper hierarchy level\n"
"@args level\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
) +
method_ext ("set_upper_hier_level", &set_upper_hier_level2,
method_ext ("set_upper_hier_level", &set_upper_hier_level2, gsi::arg ("level"), gsi::arg ("relative"),
"@brief Sets the upper hierarchy level and if it is relative to the context cell\n"
"@args level,relative\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method_ext ("set_upper_hier_level", &set_upper_hier_level3,
method_ext ("set_upper_hier_level", &set_upper_hier_level3, gsi::arg ("level"), gsi::arg ("relative"), gsi::arg ("mode"),
"@brief Sets the upper hierarchy level, if it is relative to the context cell and the mode\n"
"@args level,relative,mode\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.20.\n"
) +
method_ext ("has_upper_hier_level?", &get_has_upper_hier_level,
method_ext ("has_upper_hier_level?", &get_has_upper_hier_level, gsi::arg ("real"),
"@brief Gets a value indicating whether an upper hierarchy level is explicitly specified\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@@ -1062,9 +1009,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"See \\has_upper_hier_level for a description of this property"
) +
method_ext ("lower_hier_level", &get_lower_hier_level,
method_ext ("lower_hier_level", &get_lower_hier_level, gsi::arg ("real"),
"@brief Gets the lower hierarchy level shown\n"
"@args real\n"
"\n"
"This is the hierarchy level at which the drawing starts. "
"This property is only meaningful, if \\has_lower_hier_level is true. "
@@ -1079,9 +1025,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("lower_hier_level_relative?|#lower_hier_level_relative", &get_lower_hier_level_relative,
method_ext ("lower_hier_level_relative?|#lower_hier_level_relative", &get_lower_hier_level_relative, gsi::arg ("real"),
"@brief Gets a value indicating whether the lower hierarchy level is relative.\n"
"@args real\n"
"\n"
"See \\lower_hier_level for a description of this property.\n"
"\n"
@@ -1109,34 +1054,30 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("lower_hier_level=", &set_lower_hier_level1,
method_ext ("lower_hier_level=", &set_lower_hier_level1, gsi::arg ("level"),
"@brief Sets the lower hierarchy level\n"
"@args level\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
) +
method_ext ("set_lower_hier_level", &set_lower_hier_level2,
method_ext ("set_lower_hier_level", &set_lower_hier_level2, gsi::arg ("level"), gsi::arg ("relative"),
"@brief Sets the lower hierarchy level and if it is relative to the context cell\n"
"@args level,relative\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method_ext ("set_lower_hier_level", &set_lower_hier_level3,
method_ext ("set_lower_hier_level", &set_lower_hier_level3, gsi::arg ("level"), gsi::arg ("relative"), gsi::arg ("mode"),
"@brief Sets the lower hierarchy level, whether it is relative to the context cell and the mode\n"
"@args level,relative,mode\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.20.\n"
) +
method_ext ("has_lower_hier_level?", &get_has_lower_hier_level,
method_ext ("has_lower_hier_level?", &get_has_lower_hier_level, gsi::arg ("real"),
"@brief Gets a value indicating whether a lower hierarchy level is explicitly specified\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@@ -1152,9 +1093,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"See \\has_lower_hier_level for a description of this property"
) +
method ("source", &lay::LayerProperties::source_string,
method ("source", &lay::LayerProperties::source_string, gsi::arg ("real"),
"@brief Gets the source specification \n"
"@args real\n"
"\n"
"This method delivers the source specification as a string\n"
"\n"
@@ -1167,9 +1107,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("source=", (void (lay::LayerProperties::*) (const std::string &s)) &lay::LayerProperties::set_source,
method ("source=", (void (lay::LayerProperties::*) (const std::string &s)) &lay::LayerProperties::set_source, gsi::arg ("s"),
"@brief Loads the source specification from a string\n"
"@args s\n"
"\n"
"Sets the source specification to the given string. The source specification may contain "
"the cellview index, the source layer (given by layer/datatype or layer name), transformation, "
@@ -1240,15 +1179,13 @@ static void clear_children (lay::LayerPropertiesNode *node)
Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
decl_LayerProperties,
"lay", "LayerPropertiesNode",
method ("==", &lay::LayerPropertiesNode::operator==,
method ("==", &lay::LayerPropertiesNode::operator==, gsi::arg ("other"),
"@brief Equality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("!=", &lay::LayerPropertiesNode::operator!=,
method ("!=", &lay::LayerPropertiesNode::operator!=, gsi::arg ("other"),
"@brief Inequality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
@@ -1271,9 +1208,8 @@ Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
"\n"
"The parameterless version of this method was introduced in version 0.25."
) +
method_ext ("add_child", &add_child,
method_ext ("add_child", &add_child, gsi::arg ("child"),
"@brief Add a child entry\n"
"@args child\n"
"@return A reference to the node created\n"
"This method allows building a layer properties tree by adding children to node objects. "
"It returns a reference to the node object created.\n"
@@ -1395,24 +1331,21 @@ static lay::LayerPropertiesNodeRef current (const lay::LayerPropertiesConstItera
Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
"lay", "LayerPropertiesIterator",
method ("!=", &lay::LayerPropertiesConstIterator::operator!=,
method ("!=", &lay::LayerPropertiesConstIterator::operator!=, gsi::arg ("other"),
"@brief Inequality\n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("==", &lay::LayerPropertiesConstIterator::operator==,
method ("==", &lay::LayerPropertiesConstIterator::operator==, gsi::arg ("other"),
"@brief Equality\n"
"@args other\n"
"\n"
"@param other The other object to compare against"
"\n"
"Returns true, if self and other point to the same layer properties node. Caution: this does "
"not imply that both layer properties nodes sit in the same tab. Just their position in the tree is compared."
) +
method ("<", &lay::LayerPropertiesConstIterator::operator<,
method ("<", &lay::LayerPropertiesConstIterator::operator<, gsi::arg ("other"),
"@brief Comparison\n"
"@args other\n"
"\n"
"@param other The other object to compare against\n"
"\n"
@@ -1448,17 +1381,15 @@ Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
"If the current element does not have a parent, the iterator will\n"
"become a null iterator.\n"
) +
method ("next_sibling", &lay::LayerPropertiesConstIterator::next_sibling,
method ("next_sibling", &lay::LayerPropertiesConstIterator::next_sibling, gsi::arg ("n"),
"@brief Move to the next sibling by a given distance\n"
"\n"
"@args n\n"
"\n"
"The iterator is moved to the nth next sibling of the current element. Use negative distances to move backward.\n"
) +
method ("to_sibling", &lay::LayerPropertiesConstIterator::to_sibling,
method ("to_sibling", &lay::LayerPropertiesConstIterator::to_sibling, gsi::arg ("n"),
"@brief Move to the sibling with the given index\n"
"\n"
"@args n\n"
"\n"
"The iterator is moved to the nth sibling by selecting the nth child in the current node's parent.\n"
) +
@@ -1533,4 +1464,3 @@ Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
}
src/laybasic/laybasic/gsiDeclLayMarker.cc
+14 -29
View File
@@ -83,52 +83,45 @@ bool has_color (const lay::DMarker *marker)
}
Class<lay::DMarker> decl_Marker ("lay", "Marker",
gsi::constructor ("new", &create_marker,
gsi::constructor ("new", &create_marker, gsi::arg ("view"),
"@brief Creates a marker\n"
"@args view\n"
"\n"
"A marker is always associated with a view, in which it is shown. The "
"view this marker is associated with must be passed to the constructor."
) +
gsi::method ("set|set_box", (void (lay::DMarker::*) (const db::DBox &)) &lay::DMarker::set,
gsi::method ("set|set_box", (void (lay::DMarker::*) (const db::DBox &)) &lay::DMarker::set, gsi::arg ("box"),
"@brief Sets the box the marker is to display\n"
"@args box\n"
"\n"
"Makes the marker show a box. The box must be given in micron units.\n"
"If the box is empty, no marker is drawn.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_text", (void (lay::DMarker::*) (const db::DText &)) &lay::DMarker::set,
gsi::method ("set|set_text", (void (lay::DMarker::*) (const db::DText &)) &lay::DMarker::set, gsi::arg ("text"),
"@brief Sets the text the marker is to display\n"
"@args text\n"
"\n"
"Makes the marker show a text. The text must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_edge", (void (lay::DMarker::*) (const db::DEdge &)) &lay::DMarker::set,
gsi::method ("set|set_edge", (void (lay::DMarker::*) (const db::DEdge &)) &lay::DMarker::set, gsi::arg ("edge"),
"@brief Sets the edge the marker is to display\n"
"@args edge\n"
"\n"
"Makes the marker show a edge. The edge must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_path", (void (lay::DMarker::*) (const db::DPath &)) &lay::DMarker::set,
gsi::method ("set|set_path", (void (lay::DMarker::*) (const db::DPath &)) &lay::DMarker::set, gsi::arg ("path"),
"@brief Sets the path the marker is to display\n"
"@args path\n"
"\n"
"Makes the marker show a path. The path must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_polygon", (void (lay::DMarker::*) (const db::DPolygon &)) &lay::DMarker::set,
gsi::method ("set|set_polygon", (void (lay::DMarker::*) (const db::DPolygon &)) &lay::DMarker::set, gsi::arg ("polygon"),
"@brief Sets the polygon the marker is to display\n"
"@args polygon\n"
"\n"
"Makes the marker show a polygon. The polygon must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method_ext ("color=", set_color,
gsi::method_ext ("color=", set_color, gsi::arg ("color"),
"@brief Sets the color of the marker\n"
"@args color\n"
"The color is a 32bit unsigned integer encoding the RGB values in the lower 3 bytes (blue in the lowest significant byte). "
"The color can be reset with \\reset_color, in which case, the default foreground color is used."
) +
@@ -143,9 +136,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
gsi::method_ext ("has_color?", has_color,
"@brief Returns a value indicating whether the marker has a specific color\n"
) +
gsi::method_ext ("frame_color=", set_frame_color,
gsi::method_ext ("frame_color=", set_frame_color, gsi::arg ("color"),
"@brief Sets the frame color of the marker\n"
"@args color\n"
"The color is a 32bit unsigned integer encoding the RGB values in the lower 3 bytes (blue in the lowest significant byte). "
"The color can be reset with \\reset_frame_color, in which case the fill color is used.\n"
"The set method has been added in version 0.20.\n"
@@ -164,9 +156,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Returns a value indicating whether the marker has a specific frame color\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("dismissable=", &lay::DMarker::set_dismissable,
gsi::method ("dismissable=", &lay::DMarker::set_dismissable, gsi::arg ("flag"),
"@brief Sets a value indicating whether the marker can be hidden\n"
"@args flag\n"
"Dismissable markers can be hidden setting \"View/Show Markers\" to \"off\". "
"The default setting is \"false\" meaning the marker can't be hidden.\n"
"\n"
@@ -176,27 +167,24 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets a value indicating whether the marker can be hidden\n"
"See \\dismissable= for a description of this predicate."
) +
gsi::method ("line_width=", &lay::DMarker::set_line_width,
gsi::method ("line_width=", &lay::DMarker::set_line_width, gsi::arg ("width"),
"@brief Sets the line width of the marker\n"
"@args width\n"
"This is the width of the line drawn for the outline of the marker."
) +
gsi::method ("line_width", &lay::DMarker::get_line_width,
"@brief Gets the line width of the marker\n"
"See \\line_width= for a description of the line width."
) +
gsi::method ("vertex_size=", &lay::DMarker::set_vertex_size,
gsi::method ("vertex_size=", &lay::DMarker::set_vertex_size, gsi::arg ("size"),
"@brief Sets the vertex size of the marker\n"
"@args size\n"
"This is the size of the rectangles drawn for the vertices object."
) +
gsi::method ("vertex_size", &lay::DMarker::get_vertex_size,
"@brief Gets the vertex size of the marker\n"
"See \\vertex_size= for a description."
) +
gsi::method ("halo=", &lay::DMarker::set_halo,
gsi::method ("halo=", &lay::DMarker::set_halo, gsi::arg ("halo"),
"@brief Sets the halo flag\n"
"@args halo\n"
"The halo flag is either -1 (for taking the default), 0 to disable the halo or 1 to enable it. "
"If the halo is enabled, a pixel border with the background color is drawn around the marker, the "
"vertices and texts."
@@ -205,9 +193,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets the halo flag\n"
"See \\halo= for a description of the halo flag."
) +
gsi::method ("dither_pattern=", &lay::DMarker::set_dither_pattern,
gsi::method ("dither_pattern=", &lay::DMarker::set_dither_pattern, gsi::arg ("index"),
"@brief Sets the stipple pattern index\n"
"@args index\n"
"A value of -1 or less than zero indicates that the marker is not filled. Otherwise, the "
"value indicates which pattern to use for filling the marker."
) +
@@ -215,9 +202,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets the stipple pattern index\n"
"See \\dither_pattern= for a description of the stipple pattern index."
) +
gsi::method ("line_style=", &lay::DMarker::set_line_style,
gsi::method ("line_style=", &lay::DMarker::set_line_style, gsi::arg ("index"),
"@brief Sets the line style\n"
"@args index\n"
"The line style is given by an index. 0 is solid, 1 is dashed and so forth.\n"
"\n"
"This method has been introduced in version 0.25."
@@ -236,4 +222,3 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
);
}
src/laybasic/laybasic/gsiDeclLayMenu.cc
+22 -45
View File
@@ -87,46 +87,40 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"\n"
"This method has been introduced in version 0.26."
) +
method ("action", &lay::AbstractMenu::action,
method ("action", &lay::AbstractMenu::action, gsi::arg ("path"),
"@brief Get the reference to a Action object associated with the given path\n"
"@args path\n"
"\n"
"@param path The path to the item. This must be a valid path.\n"
"@return A reference to a Action object associated with this path\n"
) +
method ("items", &lay::AbstractMenu::items,
method ("items", &lay::AbstractMenu::items, gsi::arg ("path"),
"@brief Get the subitems for a given submenu\n"
"@args path\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,
method ("is_menu?", &lay::AbstractMenu::is_menu, gsi::arg ("path"),
"@brief Query if an item is a menu\n"
"@args path\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,
method ("is_separator?", &lay::AbstractMenu::is_separator, gsi::arg ("path"),
"@brief Query if an item is a separator\n"
"@args path\n"
"\n"
"@param path The path to the item\n"
"@return false if the path is not valid or is not a separator\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method ("is_valid?", &lay::AbstractMenu::is_valid,
method ("is_valid?", &lay::AbstractMenu::is_valid, gsi::arg ("path"),
"@brief Query if a path is a valid one\n"
"@args path\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,
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"
"@args path, name, action\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"
@@ -135,16 +129,14 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"@param name The name of the item to insert \n"
"@param action The Action object to insert\n"
) +
method ("insert_separator", &lay::AbstractMenu::insert_separator,
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"
"@args path, name\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,
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"
"@args path, name, title\n"
"\n"
"The title string optionally encodes the key shortcut and icon resource\n"
"in the form <text>[\"(\"<shortcut>\")\"][\"<\"<icon-resource>\">\"].\n"
@@ -153,15 +145,13 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"@param name The name of the submenu to insert \n"
"@param title The title of the submenu to insert\n"
) +
method ("delete_item", &lay::AbstractMenu::delete_item,
method ("delete_item", &lay::AbstractMenu::delete_item, gsi::arg ("path"),
"@brief Delete the item given by the path\n"
"@args path\n"
"\n"
"@param path The path to the item to delete\n"
) +
method ("group", &lay::AbstractMenu::group,
method ("group", &lay::AbstractMenu::group, gsi::arg ("group"),
"@brief Get the group members\n"
"@args group\n"
"\n"
"@param group The group name\n"
"@param A vector of all members (by path) of the group\n"
@@ -201,9 +191,8 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
);
Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
method ("title=", &lay::Action::set_title,
method ("title=", &lay::Action::set_title, gsi::arg ("title"),
"@brief Sets the title\n"
"@args title\n"
"\n"
"@param title The title string to set (just the title)\n"
) +
@@ -212,9 +201,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"\n"
"@return The current title string\n"
) +
method ("shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_shortcut,
method ("shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_shortcut, gsi::arg ("shortcut"),
"@brief Sets the keyboard shortcut\n"
"@args shortcut\n"
"If the shortcut string is empty, the default shortcut will be used. If the string "
"is equal to \\Action#NoKeyBound, no keyboard shortcut will be assigned.\n"
"\n"
@@ -230,9 +218,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"@brief Gets the keyboard shortcut\n"
"@return The keyboard shortcut as a string\n"
) +
method ("default_shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_default_shortcut,
method ("default_shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_default_shortcut, gsi::arg ("shortcut"),
"@brief Sets the default keyboard shortcut\n"
"@args shortcut\n"
"\n"
"The default shortcut is used, if \\shortcut is empty.\n"
"\n"
@@ -281,55 +268,47 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("separator=", &lay::Action::set_separator,
method ("separator=", &lay::Action::set_separator, gsi::arg ("separator"),
"@brief Makes an item a separator or not\n"
"@args separator\n"
"\n"
"@param separator true to make the item a separator\n"
"This method has been introduced in version 0.25.\n"
) +
method ("checkable=", &lay::Action::set_checkable,
method ("checkable=", &lay::Action::set_checkable, gsi::arg ("checkable"),
"@brief Make the item(s) checkable or not\n"
"@args checkable\n"
"\n"
"@param checkable true to make the item checkable\n"
) +
method ("enabled=", &lay::Action::set_enabled,
method ("enabled=", &lay::Action::set_enabled, gsi::arg ("enabled"),
"@brief Enable or disable the action\n"
"@args enabled \n"
"\n"
"@param enabled true to enable the item\n"
) +
method ("visible=", &lay::Action::set_visible,
method ("visible=", &lay::Action::set_visible, gsi::arg ("visible"),
"@brief Show or hide\n"
"@args visible \n"
"\n"
"@param visible true to make the item visible\n"
) +
method ("hidden=", &lay::Action::set_hidden,
method ("hidden=", &lay::Action::set_hidden, gsi::arg ("hidden"),
"@brief Sets a value that makes the item hidden always\n"
"@args hidden\n"
"See \\is_hidden? for details.\n"
"\n"
"This attribute has been introduced in version 0.25\n"
) +
method ("checked=", &lay::Action::set_checked,
method ("checked=", &lay::Action::set_checked, gsi::arg ("checked"),
"@brief Check or uncheck\n"
"@args checked \n"
"\n"
"@param checked true to make the item checked\n"
) +
method ("icon=", &lay::Action::set_icon,
method ("icon=", &lay::Action::set_icon, gsi::arg ("file"),
"@brief Set the icon to the given picture\n"
"@args file\n"
"\n"
"@param file The image file to load for the icon\n"
"\n"
"Passing an empty string will reset the icon\n"
) +
method ("icon_text=", &lay::Action::set_icon_text,
method ("icon_text=", &lay::Action::set_icon_text, gsi::arg ("icon_text"),
"@brief Set the icon's text \n"
"@args icon_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"
@@ -338,9 +317,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
method ("icon_text", &lay::Action::get_icon_text,
"@brief Get the icon's text\n"
) +
method ("tool_tip=", &lay::Action::set_tool_tip,
method ("tool_tip=", &lay::Action::set_tool_tip, gsi::arg ("text"),
"@brief Set the tool tip text \n"
"@args 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."
@@ -421,4 +399,3 @@ Class<ActionStub> decl_Action (decl_ActionBase, "lay", "Action",
);
}
src/laybasic/laybasic/gsiDeclLayPlugin.cc
+28 -66
View File
@@ -439,9 +439,8 @@ private:
};
Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
method ("register", &PluginFactoryBase::register_gsi,
method ("register", &PluginFactoryBase::register_gsi, gsi::arg ("position"), gsi::arg ("name"), gsi::arg ("title"),
"@brief Registers the plugin factory\n"
"@args position, name, title\n"
"@param position An integer that determines the order in which the plugins are created. The internal plugins use the values from 1000 to 50000.\n"
"@param name The plugin name. This is an arbitrary string which should be unique. Hence it is recommended to use a unique prefix, i.e. \"myplugin::ThePluginClass\".\n"
"@param title The title string which is supposed to appear in the tool bar and menu related to this plugin.\n"
@@ -449,9 +448,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"Registration of the plugin factory makes the object known to the system. Registration requires that the menu items have been set "
"already. Hence it is recommended to put the registration at the end of the initialization method of the factory class.\n"
) +
method ("register", &PluginFactoryBase::register_gsi2,
method ("register", &PluginFactoryBase::register_gsi2, gsi::arg ("position"), gsi::arg ("name"), gsi::arg ("title"), gsi::arg ("icon"),
"@brief Registers the plugin factory\n"
"@args position, name, title, icon\n"
"@param position An integer that determines the order in which the plugins are created. The internal plugins use the values from 1000 to 50000.\n"
"@param name The plugin name. This is an arbitrary string which should be unique. Hence it is recommended to use a unique prefix, i.e. \"myplugin::ThePluginClass\".\n"
"@param title The title string which is supposed to appear in the tool bar and menu related to this plugin.\n"
@@ -462,9 +460,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"Registration of the plugin factory makes the object known to the system. Registration requires that the menu items have been set "
"already. Hence it is recommended to put the registration at the end of the initialization method of the factory class.\n"
) +
callback ("configure", &gsi::PluginFactoryBase::configure, &gsi::PluginFactoryBase::f_configure,
callback ("configure", &gsi::PluginFactoryBase::configure, &gsi::PluginFactoryBase::f_configure, gsi::arg ("name"), gsi::arg ("value"),
"@brief Gets called for configuration events for the plugin singleton\n"
"@args name, value\n"
"This method can be reimplemented to receive configuration events "
"for the plugin singleton. Before a configuration can be received it must be "
"registered by calling \\add_option in the plugin factories' constructor.\n"
@@ -479,14 +476,12 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
) +
callback ("config_finalize", &gsi::PluginFactoryBase::config_finalize, &gsi::PluginFactoryBase::f_config_finalize,
"@brief Gets called after a set of configuration events has been sent\n"
"@args\n"
"This method can be reimplemented and is called after a set of configuration events "
"has been sent to the plugin factory singleton with \\configure. It can be used to "
"set up user interfaces properly for example.\n"
) +
callback ("menu_activated", &gsi::PluginFactoryBase::menu_activated, &gsi::PluginFactoryBase::f_menu_activated,
callback ("menu_activated", &gsi::PluginFactoryBase::menu_activated, &gsi::PluginFactoryBase::f_menu_activated, gsi::arg ("symbol"),
"@brief Gets called when a menu item is selected\n"
"@args symbol\n"
"\n"
"Usually, menu-triggered functionality is implemented in the per-view instance of the plugin. "
"However, using this method it is possible to implement functionality globally for all plugin "
@@ -496,37 +491,32 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"If this method was handling the menu event, it should return true. This indicates that the event "
"will not be propagated to other plugins hence avoiding duplicate calls.\n"
) +
callback ("initialized", &gsi::PluginFactoryBase::initialize, &gsi::PluginFactoryBase::f_initialize,
callback ("initialized", &gsi::PluginFactoryBase::initialize, &gsi::PluginFactoryBase::f_initialize, gsi::arg ("root"),
"@brief Gets called when the plugin singleton is initialized, i.e. when the application has been started.\n"
"@args root\n"
"@param root The reference to the \\MainWindow object\n"
) +
callback ("uninitialized", &gsi::PluginFactoryBase::uninitialize, &gsi::PluginFactoryBase::f_uninitialize,
callback ("uninitialized", &gsi::PluginFactoryBase::uninitialize, &gsi::PluginFactoryBase::f_uninitialize, gsi::arg ("root"),
"@brief Gets called when the application shuts down and the plugin is unregistered\n"
"This event can be used to free resources allocated with this factory singleton.\n"
"@args root\n"
"@param root The reference to the \\MainWindow object\n"
) +
factory_callback ("create_plugin", &gsi::PluginFactoryBase::create_plugin_gsi, &gsi::PluginFactoryBase::f_create_plugin,
factory_callback ("create_plugin", &gsi::PluginFactoryBase::create_plugin_gsi, &gsi::PluginFactoryBase::f_create_plugin, gsi::arg ("manager"), gsi::arg ("root"), gsi::arg ("view"),
"@brief Creates the plugin\n"
"This is the basic functionality that the factory must provide. This method must create a plugin of the "
"specific type.\n"
"@args manager, root, view\n"
"@param manager The database manager object responsible for handling database transactions\n"
"@param root The reference to the \\MainWindow object\n"
"@param view The \\LayoutView that is plugin is created for\n"
"@return The new \\Plugin implementation object\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry1,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry1, gsi::arg ("menu_name"), gsi::arg ("insert_pos"),
"@brief Specifies a separator\n"
"@args menu_name, insert_pos\n"
"Call this method in the factory constructor to build the menu items that this plugin shall create.\n"
"This specific call inserts a separator at the given position (insert_pos). The position uses abstract menu item paths "
"and \"menu_name\" names the component that will be created. See \\AbstractMenu for a description of the path.\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry2,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry2, gsi::arg ("symbol"), gsi::arg ("menu_name"), gsi::arg ("insert_pos"), gsi::arg ("title"),
"@brief Specifies a menu item\n"
"@args symbol, menu_name, insert_pos, title\n"
"Call this method in the factory constructor to build the menu items that this plugin shall create.\n"
"This specific call inserts a menu item at the specified position (insert_pos). The position uses abstract menu item paths "
"and \"menu_name\" names the component that will be created. See \\AbstractMenu for a description of the path.\n"
@@ -537,15 +527,13 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"@param insert_pos The position where to create the entry\n"
"@param title The title string for the item. The title can contain a keyboard shortcut in round braces after the title text, i.e. \"My Menu Item(F12)\"\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry3,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry3, gsi::arg ("symbol"), gsi::arg ("menu_name"), gsi::arg ("insert_pos"), gsi::arg ("title"), gsi::arg ("sub_menu"),
"@brief Specifies a menu item or sub-menu\n"
"@args symbol, menu_name, insert_pos, title, sub_menu\n"
"Similar to the previous form of \"add_menu_entry\", but this version allows also to create sub-menus by setting the "
"last parameter to \"true\""
) +
method ("add_option", &gsi::PluginFactoryBase::add_option,
method ("add_option", &gsi::PluginFactoryBase::add_option, gsi::arg ("name"), gsi::arg ("default_value"),
"@brief Specifies configuration variables.\n"
"@args name, default_value\n"
"Call this method in the factory constructor to add configuration key/value pairs to the configuration repository. "
"Without specifying configuration variables, the status of a plugin cannot be persisted. "
"\n\n"
@@ -555,9 +543,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"doing so has the advantage that it is guaranteed that a variable with this keys exists and has the given default value initially."
"\n\n"
) +
method ("has_tool_entry=", &gsi::PluginFactoryBase::has_tool_entry,
method ("has_tool_entry=", &gsi::PluginFactoryBase::has_tool_entry, gsi::arg ("f"),
"@brief Enables or disables the tool bar entry\n"
"@args f\n"
"Initially this property is set to true. This means that the plugin will have a visible entry in the toolbar. "
"This property can be set to false to disable this feature. In that case, the title and icon given on registration will be ignored. "
),
@@ -638,28 +625,24 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
);
Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
callback ("menu_activated", &gsi::PluginBase::menu_activated, &gsi::PluginBase::f_menu_activated,
callback ("menu_activated", &gsi::PluginBase::menu_activated, &gsi::PluginBase::f_menu_activated, gsi::arg ("symbol"),
"@brief Gets called when a custom menu item is selected\n"
"@args symbol\n"
"When a menu item is clicked which was registered with the plugin factory, the plugin's 'menu_activated' method is "
"called for the current view. The symbol registered for the menu item is passed in the 'symbol' argument."
) +
callback ("configure", &gsi::PluginBase::configure, &gsi::PluginBase::f_configure,
callback ("configure", &gsi::PluginBase::configure, &gsi::PluginBase::f_configure, gsi::arg ("name"), gsi::arg ("value"),
"@brief Sends configuration requests to the plugin\n"
"@args name, value\n"
"@param name The name of the configuration variable as registered in the plugin factory\n"
"@param value The value of the configuration variable\n"
"When a configuration variable is changed, the new value is reported to the plugin by calling the 'configure' method."
) +
callback ("config_finalize", &gsi::PluginBase::config_finalize, &gsi::PluginBase::f_config_finalize,
"@brief Sends the post-configuration request to the plugin\n"
"@args\n"
"After all configuration parameters have been sent, 'config_finalize' is called to given the plugin a chance to "
"update it's internal state according to the new configuration.\n"
) +
callback ("key_event", &gsi::PluginBase::key_event, &gsi::PluginBase::f_key_event,
callback ("key_event", &gsi::PluginBase::key_event, &gsi::PluginBase::f_key_event, gsi::arg ("key"), gsi::arg ("buttons"),
"@brief Handles the key pressed event\n"
"@args key, buttons\n"
"This method will called by the view on the active plugin when a button is pressed on the mouse.\n"
"\n"
"If the plugin handles the event, it should return true to indicate that the event should not be processed further."
@@ -668,9 +651,8 @@ Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
"@param buttons A combination of the constants in the \\ButtonState class which codes both the mouse buttons and the key modifiers (.e. ShiftButton etc).\n"
"@return True to terminate dispatcher\n"
) +
callback ("mouse_button_pressed_event", &gsi::PluginBase::mouse_press_event, &gsi::PluginBase::f_mouse_press_event,
callback ("mouse_button_pressed_event", &gsi::PluginBase::mouse_press_event, &gsi::PluginBase::f_mouse_press_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button pressed event\n"
"@args p, buttons, prio\n"
"This method will called by the view when a button is pressed on the mouse.\n"
"\n"
"First, the plugins that grabbed the mouse with \\grab_mouse will receive this event with 'prio' set to true "
@@ -691,76 +673,61 @@ Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
"@param buttons A combination of the constants in the \\ButtonState class which codes both the mouse buttons and the key modifiers (.e. LeftButton, ShiftButton etc).\n"
"@return True to terminate dispatcher\n"
) +
callback ("mouse_click_event", &gsi::PluginBase::mouse_click_event, &gsi::PluginBase::f_mouse_click_event,
callback ("mouse_click_event", &gsi::PluginBase::mouse_click_event, &gsi::PluginBase::f_mouse_click_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button click event (after the button has been released)\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button has been released without moving it.\n"
) +
callback ("mouse_double_click_event", &gsi::PluginBase::mouse_double_click_event, &gsi::PluginBase::f_mouse_double_click_event,
callback ("mouse_double_click_event", &gsi::PluginBase::mouse_double_click_event, &gsi::PluginBase::f_mouse_double_click_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button double-click event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button has been double-clicked.\n"
) +
callback ("leave_event", &gsi::PluginBase::leave_event, &gsi::PluginBase::f_leave_event,
callback ("leave_event", &gsi::PluginBase::leave_event, &gsi::PluginBase::f_leave_event, gsi::arg ("prio"),
"@brief Handles the leave event (mouse leaves canvas area of view)\n"
"@args prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse leaves the canvas area.\n"
"This method does not have a position nor button flags.\n"
) +
callback ("enter_event", &gsi::PluginBase::enter_event, &gsi::PluginBase::f_enter_event,
callback ("enter_event", &gsi::PluginBase::enter_event, &gsi::PluginBase::f_enter_event, gsi::arg ("prio"),
"@brief Handles the enter event (mouse enters canvas area of view)\n"
"@args prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse enters the canvas area.\n"
"This method does not have a position nor button flags.\n"
) +
callback ("mouse_moved_event", &gsi::PluginBase::mouse_move_event, &gsi::PluginBase::f_mouse_move_event,
callback ("mouse_moved_event", &gsi::PluginBase::mouse_move_event, &gsi::PluginBase::f_mouse_move_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse move event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse is moved in the canvas area.\n"
) +
callback ("mouse_button_released_event", &gsi::PluginBase::mouse_release_event, &gsi::PluginBase::f_mouse_release_event,
callback ("mouse_button_released_event", &gsi::PluginBase::mouse_release_event, &gsi::PluginBase::f_mouse_release_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button release event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button is released.\n"
) +
callback ("wheel_event", &gsi::PluginBase::wheel_event, &gsi::PluginBase::f_wheel_event,
"@args delta, horizontal, p, buttons, prio\n"
callback ("wheel_event", &gsi::PluginBase::wheel_event, &gsi::PluginBase::f_wheel_event, gsi::arg ("delta"), gsi::arg ("horizontal"), gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse wheel is rotated.\n"
"Additional parameters for this event are 'delta' (the rotation angle in units of 1/8th degree) and 'horizontal' which is true when the horizontal wheel was rotated and "
"false if the vertical wheel was rotated.\n"
) +
callback ("activated", &gsi::PluginBase::activated, &gsi::PluginBase::f_activated,
"@brief Gets called when the plugin is activated (selected in the tool bar)\n"
"@args\n"
) +
callback ("deactivated", &gsi::PluginBase::deactivated, &gsi::PluginBase::f_deactivated,
"@brief Gets called when the plugin is deactivated and another plugin is activated\n"
"@args\n"
) +
callback ("drag_cancel", &gsi::PluginBase::drag_cancel, &gsi::PluginBase::f_drag_cancel,
"@brief Gets called on various occasions when a drag operation should be canceled\n"
"@args\n"
"If the plugin implements some press-and-drag or a click-and-drag operation, this callback should "
"cancel this operation and return in some state waiting for a new mouse event."
) +
callback ("update", &gsi::PluginBase::update, &gsi::PluginBase::f_update,
"@brief Gets called when the view has changed\n"
"@args\n"
"This method is called in particular if the view has changed the visible rectangle, i.e. after zooming in or out or panning. "
"This callback can be used to update any internal states that depend on the view's state."
) +
method ("grab_mouse", &gsi::PluginBase::grab_mouse,
"@brief Redirects mouse events to this plugin, even if the plugin is not active.\n"
"@args\n"
) +
method ("ungrab_mouse", &gsi::PluginBase::ungrab_mouse,
"@brief Removes a mouse grab registered with \\grab_mouse.\n"
"@args\n"
) +
method ("set_cursor", &gsi::PluginBase::set_cursor,
method ("set_cursor", &gsi::PluginBase::set_cursor, gsi::arg ("cursor_type"),
"@brief Sets the cursor in the view area to the given type\n"
"@args cursor_type\n"
"Setting the cursor has an effect only inside event handlers, i.e. mouse_press_event. The cursor is not set permanently. Is is reset "
"in the mouse move handler unless a button is pressed or the cursor is explicitly set again in the mouse_move_event.\n"
"\n"
@@ -891,35 +858,31 @@ Class<lay::PluginRoot> decl_PluginRoot ("lay", "PluginRoot",
"\n"
"@return The instance\n"
) +
method ("write_config", &lay::PluginRoot::write_config,
method ("write_config", &lay::PluginRoot::write_config, gsi::arg ("file_name"),
"@brief Writes configuration to a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"If the configuration file cannot be written, false \n"
"is returned but no exception is thrown.\n"
) +
method ("read_config", &lay::PluginRoot::read_config,
method ("read_config", &lay::PluginRoot::read_config, gsi::arg ("file_name"),
"@brief Reads the configuration from a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"This method siletly does nothing, if the config file does not\n"
"exist. If it does and an error occurred, the error message is printed\n"
"on stderr. In both cases, false is returned.\n"
) +
method_ext ("get_config", &get_config,
method_ext ("get_config", &get_config, gsi::arg ("name"),
"@brief Gets the value of a local configuration parameter\n"
"\n"
"@args name\n"
"@param name The name of the configuration parameter whose value shall be obtained (a string)\n"
"\n"
"@return The value of the parameter or nil if there is no such parameter\n"
) +
method ("set_config", (void (lay::PluginRoot::*) (const std::string &, const std::string &)) &lay::PluginRoot::config_set,
method ("set_config", (void (lay::PluginRoot::*) (const std::string &, const std::string &)) &lay::PluginRoot::config_set, gsi::arg ("name"), gsi::arg ("value"),
"@brief Set a local configuration parameter with the given name to the given value\n"
"\n"
"@args name, value\n"
"@param name The name of the configuration parameter to set\n"
"@param value The value to which to set the configuration parameter\n"
"\n"
@@ -961,4 +924,3 @@ Class<lay::PluginRoot> decl_PluginRoot ("lay", "PluginRoot",
);
}