Page 1 of 1

Help for config dialog?

Posted: Thu Oct 01, 2009 9:18 pm
by Bartman
Is there a standard way to implement a help button on a config dialog for plugins or actions?

Re: Help for config dialog?

Posted: Thu Oct 01, 2009 10:53 pm
by stottle
I haven't looked at it in much detail, but it looks like it applies to all classes with config dialogs. Check out HeaderBox.py (in eg\classes).

It adds a help hyperlink if "more help is available", which looks like the item's description is more than one paragragh.

Code: Select all

        description = item.GetDescription().strip()
        text = GetFirstParagraph(description)
...
        hasAdditionalHelp = (description != text)
...
        if hasAdditionalHelp:
            text += ' <a href="ShowMoreHelp">%s</a>' % eg.text.General.moreTag
        self.text = '<html><body bgcolor="%s" text="%s">%s</body></html>' % (
            self.GetBackgroundColour().GetAsString(wx.C2S_HTML_SYNTAX),
            self.GetForegroundColour().GetAsString(wx.C2S_HTML_SYNTAX),
            text
        )
Brett