#---------------------------------------------------------------------------
# Name:        etg/ribbon_art.py
# Author:      Robin Dunn
#
# Created:     20-Jun-2016
# Copyright:   (c) 2016-2020 by Total Control Software
# License:     wxWindows License
#---------------------------------------------------------------------------

import etgtools
import etgtools.tweaker_tools as tools

PACKAGE   = "wx"
MODULE    = "_ribbon"
NAME      = "ribbon_art"   # Base name of the file to generate to for this script
DOCSTRING = ""

# The classes and/or the basename of the Doxygen XML files to be processed by
# this script.
ITEMS  = [ 'wxRibbonArtProvider',
           'wxRibbonMSWArtProvider',
           'wxRibbonAUIArtProvider',
           ]

#---------------------------------------------------------------------------

def run():
    # Parse the XML file(s) building a collection of Extractor objects
    module = etgtools.ModuleDef(PACKAGE, MODULE, NAME, DOCSTRING)
    etgtools.parseDoxyXML(module, ITEMS)

    #-----------------------------------------------------------------
    # Tweak the parsed meta objects in the module object as needed for
    # customizing the generated code and docstrings.

    for klass in ['wxRibbonArtProvider',
                  'wxRibbonMSWArtProvider',
                  'wxRibbonAUIArtProvider']:
        c = module.find(klass)
        assert isinstance(c, etgtools.ClassDef)
        c.find('Clone').factory = True

        m = c.findItem('GetColourScheme')
        if m:
            m.find('primary').out = True
            m.find('secondary').out = True
            m.find('tertiary').out = True
            etgtools.appendText(m.detailedDoc,
                ".. note:: The Python version of this method returns the three"
                "   scheme colours as a tuple of :class:`wx.Colour` objects.")


    module.addPyCode("""\
        if 'wxMSW' in wx.PlatformInfo:
            RibbonDefaultArtProvider = RibbonMSWArtProvider
        else:
            RibbonDefaultArtProvider = RibbonAUIArtProvider
        """)

    #-----------------------------------------------------------------
    tools.doCommonTweaks(module)
    tools.runGenerators(module)


#---------------------------------------------------------------------------
if __name__ == '__main__':
    run()