mirror of
https://github.com/KLayout/klayout.git
synced 2026-09-01 02:18:09 +02:00
Fixed some spelling errors (allow to, allows to)
This commit is contained in:
@@ -435,7 +435,7 @@ Class<BrowserSource_Stub> decl_BrowserSourceStub ("lay", "BrowserSource",
|
||||
"@args url\n"
|
||||
"\n"
|
||||
"If this method returns an empty string, the browser will not be set to \n"
|
||||
"a new location. This allows to implement any functionality behind such links.\n"
|
||||
"a new location. This allows implementing any functionality behind such links.\n"
|
||||
"If the method returns a string, the content of this string is displayed in the HTML\n"
|
||||
"browser page."
|
||||
),
|
||||
|
||||
@@ -1266,7 +1266,7 @@ Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
|
||||
method_ext ("add_child", &add_child0,
|
||||
"@brief Add a child entry\n"
|
||||
"@return A reference to the node created\n"
|
||||
"This method allows to build a layer properties tree by adding children to node objects. "
|
||||
"This method allows building a layer properties tree by adding children to node objects. "
|
||||
"It returns a reference to the node object created which is a freshly initialized one.\n"
|
||||
"\n"
|
||||
"The parameterless version of this method was introduced in version 0.25."
|
||||
@@ -1275,7 +1275,7 @@ Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
|
||||
"@brief Add a child entry\n"
|
||||
"@args child\n"
|
||||
"@return A reference to the node created\n"
|
||||
"This method allows to build a layer properties tree by adding children to node objects. "
|
||||
"This method allows building a layer properties tree by adding children to node objects. "
|
||||
"It returns a reference to the node object created.\n"
|
||||
"\n"
|
||||
"This method was introduced in version 0.22."
|
||||
|
||||
@@ -437,7 +437,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"@param add_default If true, default layers will be added for each other layer in the layout\n"
|
||||
"\n"
|
||||
"Load the layer properties from the file given in \"fn\".\n"
|
||||
"This version allows to specify whether defaults should be used for all other layers by "
|
||||
"This version allows one to specify whether defaults should be used for all other layers by "
|
||||
"setting \"add_default\" to true.\n"
|
||||
"\n"
|
||||
"This variant has been added on version 0.21."
|
||||
@@ -450,7 +450,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"@param add_default If true, default layers will be added for each other layer in the layout\n"
|
||||
"\n"
|
||||
"Load the layer properties from the file given in \"fn\".\n"
|
||||
"This version allows to specify whether defaults should be used for all other layers by "
|
||||
"This version allows one to specify whether defaults should be used for all other layers by "
|
||||
"setting \"add_default\" to true. It can be used to load the layer properties for a specific "
|
||||
"cellview by setting \"cv_index\" to the index for which the layer properties file should be applied. "
|
||||
"All present definitions for this layout will be removed before the properties file is loaded. \"cv_index\" can "
|
||||
@@ -465,7 +465,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"\n"
|
||||
"@param level The minimum level above which to display something\n"
|
||||
"\n"
|
||||
"This methods allows to set the minimum hierarchy level above which to display geometries."
|
||||
"This methods allows setting the minimum hierarchy level above which to display geometries."
|
||||
"This method may cause a redraw if required."
|
||||
) +
|
||||
gsi::method ("min_hier_levels", &lay::LayoutView::get_min_hier_levels,
|
||||
@@ -478,7 +478,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"\n"
|
||||
"@param level The maximum level below which to display something\n"
|
||||
"\n"
|
||||
"This methods allows to set the maximum hierarchy below which to display geometries."
|
||||
"This methods allows setting the maximum hierarchy below which to display geometries."
|
||||
"This method may cause a redraw if required."
|
||||
) +
|
||||
gsi::method ("max_hier_levels", &lay::LayoutView::get_max_hier_levels,
|
||||
@@ -528,7 +528,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"@brief Create a new, empty layout and associate it with the given technology\n"
|
||||
"\n"
|
||||
"The add_cellview parameter controls whether to create a new cellview (true)\n"
|
||||
"or clear all cellviews before (false). This variant also allows to control whether the layer properties are\n"
|
||||
"or clear all cellviews before (false). This variant also allows one to control whether the layer properties are\n"
|
||||
"initialized (init_layers = true) or not (init_layers = false).\n"
|
||||
"\n"
|
||||
"@return The index of the cellview created.\n"
|
||||
@@ -572,7 +572,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"The technology to use for that layout can be specified as well with the 'tech' parameter. Depending "
|
||||
"on the definition of the technology, layer properties may be loaded for example.\n"
|
||||
"The technology string can be empty for the default technology.\n"
|
||||
"This variant also allows to control whether the layer properties are\n"
|
||||
"This variant also allows one to control whether the layer properties are\n"
|
||||
"initialized (init_layers = true) or not (init_layers = false).\n"
|
||||
"\n"
|
||||
"Note: once a layout is passed to the view with show_layout, it is owned by the view and must not be "
|
||||
|
||||
@@ -51,7 +51,7 @@ namespace gsi
|
||||
// TODO: these static variables are a bad hack!
|
||||
// However it's not easy to pass parameters to a C++ classes constructor in Ruby without
|
||||
// compromising the capability to derive from that class (at least I have not learned how
|
||||
// to create a "new" in the super class *and* allow to "new" the derived class). Anyway,
|
||||
// to create a "new" in the super class *and* allow a "new" of the derived class). Anyway,
|
||||
// since PluginBase object are only allowed to be created inside the create_plugin method
|
||||
// of the factory, this hack is a quick but dirty workaround.
|
||||
static bool s_in_create_plugin = false;
|
||||
@@ -457,7 +457,7 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
|
||||
"@param title The title string which is supposed to appear in the tool bar and menu related to this plugin.\n"
|
||||
"@param icon The path to the icon that appears in the tool bar and menu related to this plugin.\n"
|
||||
"\n"
|
||||
"This version also allows to register an icon for the tool bar.\n"
|
||||
"This version also allows registering an icon for the tool bar.\n"
|
||||
"\n"
|
||||
"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"
|
||||
|
||||
@@ -60,7 +60,7 @@
|
||||
#include <map>
|
||||
|
||||
// --------------------------------------------------------------
|
||||
// A helper class that allows to put a QImage into a tl::Variant
|
||||
// A helper class that allows putting a QImage into a tl::Variant
|
||||
|
||||
namespace tl
|
||||
{
|
||||
|
||||
@@ -107,8 +107,8 @@ private:
|
||||
* @brief A QAction proxy
|
||||
*
|
||||
* This class is provided to be better suited to automation because it provides the corresponding interfaces
|
||||
* and allows to implement the "trigger" event by reimplementation of the slot (after being connected).
|
||||
* In addition, by acting as a proxy, it allows to reference a QAction object created by Qt itself (i.e.
|
||||
* and allows implementing the "trigger" event by reimplementation of the slot (after being connected).
|
||||
* In addition, by acting as a proxy, it can act as a reference to a QAction object created by Qt itself (i.e.
|
||||
* within a QMenu).
|
||||
* To reimplement the "triggered" method, derive a class from Action and reimplement "triggered". Then
|
||||
* pass a reference to this object to "insert_item" of AbstractMenu and store away the derived object.
|
||||
|
||||
@@ -63,7 +63,7 @@ public:
|
||||
* This method can be overloaded by derived classes to provide actions
|
||||
* for activation of the dialog, like setup of the controls etc.
|
||||
* This handler is called immediately before the dialog becomes visible.
|
||||
* The 'active' method allows to query if the dialog is active.
|
||||
* The 'active' method returns a value indicating whether the dialog is active.
|
||||
*/
|
||||
virtual void activated ()
|
||||
{
|
||||
|
||||
@@ -190,7 +190,7 @@ public:
|
||||
* @brief Get the HTML code for a given "int" URL.
|
||||
*
|
||||
* If this method returns an empty string, the browser will not be set to
|
||||
* a new location. This allows to implement any functionality behind such links.
|
||||
* a new location. This allows implementing any functionality behind such links.
|
||||
*/
|
||||
virtual std::string get (const std::string &url);
|
||||
|
||||
@@ -250,7 +250,7 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief A specialisation of QTextBrowser that allows to load a specific resource through BrowserPanel
|
||||
* @brief A specialisation of QTextBrowser that allows loading a specific resource through BrowserPanel
|
||||
*/
|
||||
class LAYBASIC_PUBLIC BrowserTextWidget
|
||||
: public QTextBrowser
|
||||
@@ -274,7 +274,7 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief A specialisation of QWidget around a TextBrowser that allows to load a specific resource
|
||||
* @brief A specialisation of QWidget around a TextBrowser that allows loading a specific resource
|
||||
*/
|
||||
class LAYBASIC_PUBLIC BrowserPanel
|
||||
: public QWidget
|
||||
|
||||
@@ -146,7 +146,7 @@ public:
|
||||
* This method will throw an exception if the string does not have a valid format
|
||||
* like the one returned by the to_string method.
|
||||
*
|
||||
* If simple is true, this method allows to set a palette without luminous colors
|
||||
* If simple is true, this method allows setting a palette without luminous colors
|
||||
* and without colors at all.
|
||||
*/
|
||||
void from_string (const std::string &s, bool simple = false);
|
||||
|
||||
@@ -39,7 +39,7 @@ namespace lay
|
||||
* @brief Generic file dialog
|
||||
*
|
||||
* This dialog is provided to encapsulate the Qt file dialog.
|
||||
* This implementation allows to stay within a directory even
|
||||
* This implementation allows staying within a directory even
|
||||
* if the static convenience functions are used. Under Windows,
|
||||
* we need to use the static functions since these use the
|
||||
* system dialogs.
|
||||
|
||||
@@ -88,7 +88,7 @@ protected:
|
||||
/**
|
||||
* @brief The hierarchy control panel
|
||||
*
|
||||
* The hierarchy control panel allows to change the cell shown
|
||||
* The hierarchy control panel allows changing the cell shown, to
|
||||
* browse the hierarchy and disable/enable cells
|
||||
*
|
||||
* The class communicates with a Layout interface for
|
||||
@@ -186,7 +186,7 @@ public:
|
||||
* @brief Update the contents if necessary
|
||||
*
|
||||
* Update the cell trees according to the hierarchy found in
|
||||
* the layouts. This version allows to give an hint what cellview has changed.
|
||||
* the layouts. This version includes a hint which cellview has changed.
|
||||
*/
|
||||
void do_update_content (int cv_index);
|
||||
|
||||
|
||||
@@ -1446,7 +1446,7 @@ struct LAYBASIC_PUBLIC CompareLayerIteratorBottomUp
|
||||
* @brief Flat, non-const layer iterator
|
||||
*
|
||||
* This iterator provides a flat view for the layers in the layer tree
|
||||
* and allows to change the item pointed to.
|
||||
* and allows changing the item pointed to.
|
||||
*/
|
||||
class LAYBASIC_PUBLIC LayerPropertiesIterator
|
||||
: public LayerPropertiesConstIterator
|
||||
|
||||
@@ -2691,7 +2691,7 @@ LayoutView::save_screenshot (const std::string &fn)
|
||||
|
||||
QImageWriter writer (tl::to_qstring (fn), QByteArray ("PNG"));
|
||||
|
||||
// Unfortunately the PNG writer does not allow to write long strings.
|
||||
// Unfortunately the PNG writer does not allow writing of long strings.
|
||||
// We separate the description into a set of keys:
|
||||
|
||||
for (unsigned int i = 0; i < cellviews (); ++i) {
|
||||
@@ -2748,7 +2748,7 @@ LayoutView::save_image (const std::string &fn, unsigned int width, unsigned int
|
||||
|
||||
QImageWriter writer (tl::to_qstring (fn), QByteArray ("PNG"));
|
||||
|
||||
// Unfortunately the PNG writer does not allow to write long strings.
|
||||
// Unfortunately the PNG writer does not allow writing of long strings.
|
||||
// We separate the description into a set of keys:
|
||||
|
||||
for (unsigned int i = 0; i < cellviews (); ++i) {
|
||||
@@ -2780,7 +2780,7 @@ LayoutView::save_image_with_options (const std::string &fn,
|
||||
|
||||
QImageWriter writer (tl::to_qstring (fn), QByteArray ("PNG"));
|
||||
|
||||
// Unfortunately the PNG writer does not allow to write long strings.
|
||||
// Unfortunately the PNG writer does not allow writing of long strings.
|
||||
// We separate the description into a set of keys:
|
||||
|
||||
for (unsigned int i = 0; i < cellviews (); ++i) {
|
||||
|
||||
@@ -295,7 +295,7 @@ public:
|
||||
/**
|
||||
* @brief Fill the layer properties for a new layer
|
||||
*
|
||||
* The layer's source must be set already to allow to compute the initial color.
|
||||
* The layer's source must be set already to allow computing of the initial color.
|
||||
* It is assumed that the layer is appended at the end of the layer list. This
|
||||
* is important to set the dither pattern index accordingly.
|
||||
*/
|
||||
@@ -798,7 +798,7 @@ public:
|
||||
*
|
||||
* @param fn The file to load
|
||||
*
|
||||
* This version allows to specify whether defaults should be used for all other layers by
|
||||
* This version allows one to specify whether defaults should be used for all other layers by
|
||||
* setting add_default to true
|
||||
*/
|
||||
void load_layer_props (const std::string &fn, bool add_default);
|
||||
@@ -808,7 +808,7 @@ public:
|
||||
*
|
||||
* @param fn The file to load
|
||||
*
|
||||
* This version allows to specify whether defaults should be used for all other layers by
|
||||
* This version allows one to specify whether defaults should be used for all other layers by
|
||||
* setting add_default to true. In addition, this version will apply the .lyp definitions
|
||||
* to a specific cellview after removing all definitions for this one. If cv_index is set
|
||||
* to -1, the .lyp file will be applied to each cellview. In any case, the cv index specs
|
||||
@@ -1366,7 +1366,7 @@ public:
|
||||
* @brief Create a new, empty layout using the specified technology
|
||||
*
|
||||
* The add_cellview param controls whether to create a new cellview
|
||||
* or clear all cellviews before. This version allows to specify whether layer properties shall be created.
|
||||
* or clear all cellviews before. This version allows one to specify whether layer properties shall be created.
|
||||
*
|
||||
* @return The index of the cellview created.
|
||||
*/
|
||||
@@ -1378,7 +1378,7 @@ public:
|
||||
* The add_cellview param controls whether to add the layout as a new cellview
|
||||
* or clear all cellviews before.
|
||||
*
|
||||
* The "initialize_layers" parameter allows to specify whether the layer properties shall be initialized.
|
||||
* The "initialize_layers" parameter allows one to specify whether the layer properties shall be initialized.
|
||||
*
|
||||
* @return The index of the cellview loaded.
|
||||
*/
|
||||
|
||||
@@ -542,7 +542,7 @@ public:
|
||||
* selection. The set should be empty on enter. Otherwise the results are
|
||||
* not defined.
|
||||
* The return value is true if the ids are to be interpretated inversely (every properties id
|
||||
* matches that is not in the set). This allows to optimize the computation of the set.
|
||||
* matches that is not in the set). This allows optimizing the computation of the set.
|
||||
*/
|
||||
bool matching (const db::PropertiesRepository &rep, std::set<db::properties_id_type> &matching) const;
|
||||
|
||||
|
||||
@@ -120,7 +120,7 @@ PluginDeclaration::init_menu ()
|
||||
|
||||
lay::AbstractMenu &menu = *lay::AbstractMenuProvider::instance ()->menu ();
|
||||
|
||||
// pre-initialize to allow to multiple init_menu calls
|
||||
// pre-initialize to allow multiple init_menu calls
|
||||
m_editable_mode_action = lay::Action ();
|
||||
m_mouse_mode_action = lay::Action ();
|
||||
m_menu_actions.clear ();
|
||||
|
||||
@@ -164,7 +164,7 @@ private:
|
||||
std::string m_format_name;
|
||||
db::StreamFormatDeclaration *mp_stream_fmt;
|
||||
|
||||
// don't allow to override - use a special configuration page for that purpose.
|
||||
// don't allow overrides - use a special configuration page for that purpose.
|
||||
virtual ConfigPage *config_page (QWidget * /*parent*/, std::string & /*title*/) const
|
||||
{
|
||||
return 0;
|
||||
|
||||
@@ -55,7 +55,7 @@ public:
|
||||
*
|
||||
* Creates a tip dialog with the given parent, message text and configuration key. The configuration key
|
||||
* is the key under which the status of the dialog is stored.
|
||||
* The buttons argument allows to specify which buttons to show (see buttons_type enum for the button
|
||||
* The buttons argument allows one to specify which buttons to show (see buttons_type enum for the button
|
||||
* combinations available.
|
||||
*/
|
||||
TipDialog (QWidget *parent, const std::string &text, const std::string &key, buttons_type buttons = close_buttons);
|
||||
|
||||
@@ -112,7 +112,7 @@ private:
|
||||
/**
|
||||
* @brief A library selection combo box
|
||||
*
|
||||
* This combo box allows to select a library
|
||||
* This combo box allows selecting a library
|
||||
*/
|
||||
class LAYBASIC_PUBLIC LibrarySelectionComboBox
|
||||
: public QComboBox
|
||||
@@ -166,7 +166,7 @@ private:
|
||||
/**
|
||||
* @brief A layer selection combo box
|
||||
*
|
||||
* This combo box allows to select a (physical) layer from a layout
|
||||
* This combo box allows selecting a (physical) layer from a layout
|
||||
*/
|
||||
class LAYBASIC_PUBLIC LayerSelectionComboBox
|
||||
: public QComboBox
|
||||
@@ -254,7 +254,7 @@ private:
|
||||
/**
|
||||
* @brief A cell view selection combo box
|
||||
*
|
||||
* This combo box allows to select a cellview from a lay::LayoutView
|
||||
* This combo box allows selecting a cellview from a lay::LayoutView
|
||||
*/
|
||||
class LAYBASIC_PUBLIC CellViewSelectionComboBox
|
||||
: public QComboBox
|
||||
|
||||
Reference in New Issue
Block a user