Purposed of the Builder Output file?

[AJ6CU]

I am generating code as a custom widget. And noticed that there is a fooBO.py file generated (and of course you can set where that is stored in settings).

What is its purpose? It doesn't seem to be imported by the "module" file and I can even delete it and the application still runs. When do I need it?

Thanks

Mark

[alejandroautalan]

What is its purpose? It doesn't seem to be imported by the "module" file and I can even delete it and the application still runs. When do I need it?

The Custom widget template generates three files:

• foowidgetui.py: tkinter code generated by designer
• foowidget.py: file for your custom code.
• foowidgetBO.py: Builder Object class used to build the widget in XML mode or inside designer.

So with the designer open with another myapp.ui you can go to Project->Settings->CustomWidgets and load the foowidgetbo.py. If everything went well, you will be able to see the new widget in the component palette.

Some docs about the BuilderObjet is here https://github.com/alejandroautalan/pygubu-designer/wiki/Design-Reuse
but it's a bit outdated.

The custom widget templates are very usefull if you want to split a complex application in little components
and continue using the designer to fix things in the design.
I consider that it is not complete yet, although pygubu-designer uses it a lot.

I think I can make a little video showing how to use it.

Let me know.
Regards
Alejandro A.

[AJ6CU]

Thank you! That makes a lot of sense. In a prior life, where our primary product was selling a gui builder for Motif, the adding of additional widgets was always difficult and consumed a lot of our customer support teams time. Sounds like you have a plan to avoid this!

Mark

[AJ6CU]

Hi,

Made a lot of progress following instructions. To get the register_custom_property to work, pycharm insisted to import a library from the builder, unfortunately, cannot figure out where this library was imported or where it was (pretty much a pycharm beginner...)

I did come across one issue that I can't seem to work around.

Trying to add a custom property for a command. So registered:

register_custom_property ( _builder_id, "command", "commandentry" )

The command editor appears normal in the builder with the selection box for callback type, but the code generated is:

self.ATT_Jogwheel.configure(button_radius=25, command="{"name": "command", "type": "command", "cbtype": "simple", "value": "updateATTValue_CB"}", radius=200, scroll_steps=10, value=70)
Bet there is some processing that needs to be done like for integers?

Have atttached the whole .bo file for context (changed .py to .txt to allow uploard). This is for the jogwheel from TkDial.

Regards,

Mark
JogwheelCustom_UXbo.txt

[alejandroautalan]

Hello @AJ6CU, I'm glad you've made progress in creating your own widgets.

Trying to add a custom property for a command. So registered:

register_custom_property ( _builder_id, "command", "commandentry" )

Bet there is some processing that needs to be done like for integers?

First, mark the property in the class builder as a command for pygubu:

class JogwheelCustom_UXbo(BuilderObject):
    class_ = JogwheelCustom
    OPTIONS_CUSTOM = {
        "start",
        "end",
        "divisions",
        "value",
        "scroll_steps",
        "radius",
        "button_radius",
        "command"
    }
    ro_properties = ("start", "end", "divisions")
    properties = OPTIONS_CUSTOM

    command_properties = ("command",)  # <--- Here mark "command" property as a command for pygubu.

    ...

Then, if the property can be configured using the configure method of your custom widget ("tkinter way") no additional changes are needed.

If not, you need to override another method to process code generation.

class JogwheelCustom_UXbo(BuilderObject):
    class_ = JogwheelCustom

    ...

    command_properties = ("command",)  # <--- Here mark "command" property as a command for pygubu.

    def _code_set_property(self, targetid, pname, value, code_bag):
        if pname == "command":
            code_bag[pname] = [f"{targetid}.yourFunctionToSetupCmd({value})", ]
        else:
            super(JogwheelCustom_UXbo, self)._code_set_property(
                targetid, pname, value, code_bag
            )

Let me know.
Regards

[AJ6CU]

The command_property suggestion worked great!

The only issue was that this widget did not include a "command" configure option. Tried the extra code you suggested, and even made "command" read-only, but pygubu-designer still tried to add the callback via a configure option. (So both in the constructor and with a subsequent foo.configure(command=mycallback).

I just added a "command" option for configure to the jogwheel. Took 2 minutes. But thought I would report the duplicate code generation. If i is an obvous user error, let me know. Otherwise I got everything working on my end. It was amazingly easy to add a third party widget! Great job. This is usually such a horror story in most gui builders.

Regards,

Mark

[alejandroautalan]

The command_property suggestion worked great!

Great! Yes, the "configure method" way is the easiest.

Maybe I was hasty in mentioning the second option, as I think it requires additional steps.
But, I'll review what you mentioned anyway.

Regards!