In the previous article – Developing a QGIS Plugin: Why and How to Create a Plugin<\/a> , Developing a QGIS Plugin: Creating a Plugin with Plugin Builder<\/a> , Developing a QGIS Plugin: Adding a Button and a Dialog<\/a> <\/em>– we learned how to create a plugin, add a user interface, and retrieve values entered by the user..<\/p>\n\n\n\n

At that stage, the plugin can collect information, but it does not yet know whether that information makes sense.<\/p>\n\n\n\n

This is where business logic comes in.<\/p>\n\n\n\n

Business logic is simply a set of rules that determine how your plugin should behave.<\/p>\n\n\n\n

For example:<\/p>\n\n\n\n

\n
A buffer distance must be greater than zero.<\/li>\n\n\n\n
A percentage must be between 0 and 100.<\/li>\n\n\n\n
A required field cannot be empty.<\/li>\n\n\n\n
An advanced option should only be available under specific conditions.<\/li>\n<\/ul>\n\n\n\n
Without these rules, a plugin becomes fragile and prone to errors.<\/p>\n\n\n\n
\n\n\n\n
<\/span>Why a Button Does Not \u00ab\u00a0Do Anything\u00a0\u00bb by Itself<\/span><\/h2>\n\n\n\n
Before going further, it is important to understand a fundamental concept:<\/p>\n\n\n\n
\n
A Qt dialog does not perform any action on its own.<\/p>\n<\/blockquote>\n\n\n\n
Its role is simply to:<\/p>\n\n\n\n
\n
display input fields (text boxes, drop-down lists, check boxes, etc.),<\/li>\n\n\n\n
allow the user to enter or select values,<\/li>\n\n\n\n
present information in a graphical interface.<\/li>\n<\/ul>\n\n\n\n
If your plugin does not explicitly read those values and use them in Python code, nothing happens\u2014and that is perfectly normal.<\/p>\n\n\n\n
The dialog is only a user interface. The actual behavior of the plugin is defined by the code you write.<\/p>\n\n\n\n
\n\n\n\n
<\/span>Where Are the Values Stored?<\/span><\/h2>\n\n\n\n
Every widget displayed in the dialog is a Python object created from the .ui<\/code> file.<\/p>\n\n\n\n
Common examples include:<\/p>\n\n\n\n
\nQLineEdit<\/code> \u2192 text field<\/li>\n\n\n\n QComboBox<\/code> \u2192 drop-down list<\/li>\n\n\n\n QCheckBox<\/code> \u2192 check box<\/li>\n\n\n\n QSpinBox<\/code> \u2192 numeric input<\/li>\n<\/ul>\n\n\n\nThese widgets are accessible through the dialog object (dlg<\/code>).<\/p>\n\n\n\n For example:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nself.dlg.lineEdit self.dlg.comboBox self.dlg.checkBox<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n The value entered by the user is stored inside the widget itself.<\/p>\n\n\n\n Your plugin must explicitly retrieve that value before it can use it.<\/p>\n\n\n\n For example:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nname = self.dlg.lineEdit.text()<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n This line reads the contents of a text field and stores it in the variable name<\/code>.<\/p>\n\n\n\n From that point on, your plugin can apply validation rules, perform calculations, or launch processing algorithms.<\/p>\n\n\n\n <\/span>Reading Values: Simple Examples<\/span><\/h2>\n\n\n\nOnce you know where the values are stored, the next step is to retrieve them from the dialog widgets.<\/p>\n\n\n\n Each widget type has its own method for accessing the user’s input.<\/p>\n\n\n\n <\/span>Text Field (QLineEdit<\/code>)<\/span><\/h3>\n\n\n<\/div><\/div><\/div><\/div><\/p>\n\n\n\ntext = self.dlg.lineEdit.text()<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n \n text<\/code> contains whatever the user typed into the field.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Drop-Down List (QComboBox<\/code>)<\/span><\/h3>\n\n\n<\/div><\/div><\/div><\/div><\/p>\n\n\n\nchoice = self.dlg.comboBox.currentText()<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n \nchoice<\/code> contains the currently selected item.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Check Box (QCheckBox<\/code>)<\/span><\/h3>\n\n\n<\/div><\/div><\/div><\/div><\/p>\n\n\n\nenabled = self.dlg.checkBox.isChecked()<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n \n enabled<\/code> contains either True<\/code> or False<\/code>.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Numeric Field (QSpinBox<\/code>)<\/span><\/h3>\n\n\n<\/div><\/div><\/div><\/div><\/p>\n\n\n\nvalue = self.dlg.spinBox.value()<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n \n value<\/code> contains a numeric value.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>The Critical Moment: When to Read Values<\/span><\/h2>\n\n\n\nA common beginner mistake is trying to read values before the user has validated the dialog.<\/p>\n\n\n\n In a typical QGIS plugin, values should be retrieved only after the dialog has been accepted.<\/p>\n\n\n\n For example:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nresult = self.dlg.exec_() if result: # read the values here<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n The call to exec_()<\/code> displays the dialog and waits for the user to interact with it.<\/p>\n\n\n\n If you try to read the values before exec_()<\/code> is executed, you are usually reading empty fields or default values.<\/p>\n\n\n\n \n The user must first fill in the dialog and click OK<\/strong> before your plugin can reliably access the entered data.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Validating User Input<\/span><\/h2>\n\n\n\nImagine a plugin that asks the user to enter a buffer distance.<\/p>\n\n\n\n Before using that value, the plugin should verify that it is valid.<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\ndistance = float(self.dlg.lineEditDistance.text())\n\nif distance <= 0:\n QMessageBox.warning(\n self.dlg,\n \"Invalid Distance\",\n \"Please enter a value greater than zero.\"\n )\n return\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n In this example:<\/p>\n\n\n\n \nthe value entered by the user is converted to a number,<\/li>\n\n\n\n the plugin checks whether the value is positive,<\/li>\n\n\n\n a warning message is displayed if the value is invalid,<\/li>\n\n\n\n processing stops immediately.<\/li>\n<\/ul>\n\n\n\nThis simple check prevents many avoidable errors.<\/p>\n\n\n\n \n\n\n\n<\/span>Handling Empty Fields<\/span><\/h2>\n\n\n\nOne of the most common user mistakes is leaving a required field empty.<\/p>\n\n\n\n For example:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nname = self.dlg.lineEditName.text()\n\nif not name:\n QMessageBox.warning(\n self.dlg,\n \"Missing Information\",\n \"Please enter a project name.\"\n )\n return\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n Instead of failing later, the plugin immediately explains what is missing.<\/p>\n\n\n\n This greatly improves the user experience.<\/p>\n\n\n\n \nChecking for missing values is one of the simplest ways to improve the reliability of a plugin.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Different Inputs, Different Actions<\/span><\/h2>\n\n\n\nBusiness logic is not limited to validation.<\/p>\n\n\n\n It can also determine which action should be performed.<\/p>\n\n\n\n Imagine a combo box containing two processing modes:<\/p>\n\n\n\n Processing Mode\n- Standard\n- Advanced\n<\/code><\/pre>\n\n\n\nThe plugin can execute different code depending on the selected option.<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nmode = self.dlg.comboBoxMode.currentText()\n\nif mode == \"Standard\":\n self.run_standard_processing()\nelse:\n self.run_advanced_processing()\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n The same interface can therefore lead to completely different workflows.<\/p>\n\n\n\n \n\n\n\n<\/span>Combining Multiple Rules<\/span><\/h2>\n\n\n\nReal-world plugins rarely rely on a single condition.<\/p>\n\n\n\n More often, several checks are combined before processing begins.<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nif distance > 0 and percentage <= 100:\n self.process_data()\nelse:\n QMessageBox.warning(\n self.dlg,\n \"Invalid Parameters\",\n \"Please review the values entered.\"\n )\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n The plugin verifies that all conditions are satisfied before continuing.<\/p>\n\n\n\n This approach makes tools more robust and predictable.<\/p>\n\n\n\n \n\n\n\n<\/span>Providing Useful Feedback<\/span><\/h2>\n\n\n\nUsers appreciate plugins that explain what is happening.<\/p>\n\n\n\n Whenever possible, display clear messages.<\/p>\n\n\n\n For example:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nQMessageBox.information(\n self.dlg,\n \"Processing Complete\",\n \"The analysis finished successfully.\"\n)\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n Or:<\/p>\n\n\n <\/div><\/div><\/div><\/div><\/p>\n\n\n\nQMessageBox.warning(\n self.dlg,\n \"Invalid Input\",\n \"The buffer distance must be greater than zero.\"\n)\n<\/code><\/pre>\n\n\n<\/div><\/div>\n\n\n\n Good messages should:<\/p>\n\n\n\n \nexplain the problem,<\/li>\n\n\n\n indicate how to fix it,<\/li>\n\n\n\n avoid unnecessary technical terms.<\/li>\n<\/ul>\n\n\n\nA helpful message is often better than a detailed error traceback.<\/p>\n\n\n\n \n\n\n\n<\/span>Business Logic Does Not Mean Complex Code<\/span><\/h2>\n\n\n\nMany beginners assume that business logic requires advanced programming.<\/p>\n\n\n\n In reality, most business rules are simply a series of questions:<\/p>\n\n\n\n \nIs the value valid?<\/li>\n\n\n\n Is the field empty?<\/li>\n\n\n\n Which option was selected?<\/li>\n\n\n\n Should processing continue?<\/li>\n<\/ul>\n\n\n\nMost useful plugins are built from many small decisions rather than sophisticated algorithms.<\/p>\n\n\n\n \nGood business logic is often more valuable than sophisticated code.<\/p>\n<\/blockquote>\n\n\n\n \n\n\n\n<\/span>Testing Your Rules<\/span><\/h2>\n\n\n\nWhenever you add validation rules, test several situations:<\/p>\n\n\n\n \nvalid values,<\/li>\n\n\n\n invalid values,<\/li>\n\n\n\n empty fields,<\/li>\n\n\n\n unexpected inputs.<\/li>\n<\/ul>\n\n\n\nA plugin should behave correctly even when users make mistakes.<\/p>\n\n\n\n Testing helps identify weaknesses before your users do.<\/p>\n\n\n\n \n\n\n\n<\/span>Common Beginner Mistakes<\/span><\/h2>\n\n\n\nAt this stage, beginners often:<\/p>\n\n\n\n \ntrust user input too much,<\/li>\n\n\n\n forget to check for empty fields,<\/li>\n\n\n\n display vague error messages,<\/li>\n\n\n\n continue processing despite invalid values.<\/li>\n<\/ul>\n\n\n\nThese mistakes are normal and become easier to avoid with experience.<\/p>\n\n\n\n \n\n\n\n<\/span>What You Have Learned<\/span><\/h2>\n\n\n\nBy the end of this article, you now understand:<\/p>\n\n\n\n \nwhat business logic is,<\/li>\n\n\n\n why input validation is important,<\/li>\n\n\n\n how to display helpful messages,<\/li>\n\n\n\n how to execute different actions depending on user choices.<\/li>\n<\/ul>\n\n\n\nYour plugin is no longer just collecting information\u2014it is starting to make decisions.<\/p>\n\n\n\n \n\n\n\n<\/span>What’s Next?<\/span><\/h2>\n\n\n\nIn the next article, we will see how to:<\/p>\n\n\n\n \nwork with the active layer,<\/li>\n\n\n\n access selected features,<\/li>\n\n\n\n process only the selected features.<\/li>\n<\/ul>\n\n\n\n\nThis is where your plugin begins to interact directly with geographic data and becomes truly useful.<\/p>\n<\/blockquote>\n\n\n\n \n","protected":false},"excerpt":{"rendered":"Collecting user input is an important milestone in QGIS plugin development. However, a useful plugin does more than simply read values entered in a dialog box. It validates data, applies rules, and makes decisions based on…<\/p>\n","protected":false},"author":1,"featured_media":16325,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"sfsi_plus_gutenberg_text_before_share":"","sfsi_plus_gutenberg_show_text_before_share":"","sfsi_plus_gutenberg_icon_type":"","sfsi_plus_gutenberg_icon_alignemt":"","sfsi_plus_gutenburg_max_per_row":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[3394,1377],"tags":[4692,4686,4690,4137,4688],"class_list":["post-16828","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-pluigin-en","category-qgis-en","tag-pyqgis-tutorial-en","tag-pyqgis-user-input","tag-qgis-business-rules","tag-qgis-plugin-development","tag-qgis-plugin-validation"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t