__FCMUserWindow.lua

--  Author: Edward Koltun
--  Date: March 3, 2022
--[[
$module __FCMUserWindow

## Summary of Modifications
- Setters that accept `FCString` will also accept a Lua `string`.
- `FCString` parameter in getters is optional and if omitted, the result will be returned as a Lua `string`.
]] --
local mixin = require("library.mixin") -- luacheck: ignore
local mixin_helper = require("library.mixin_helper")

local class = {Methods = {}}
local methods = class.Methods

local temp_str = finale.FCString()

--[[
% GetTitle

**[?Fluid] [Override]**

Override Changes:
- Passing an `FCString` is optional. If omitted, the result is returned as a Lua `string`. If passed, nothing is returned and the method is fluid.

@ self (__FCMUserWindow)
@ [title] (FCString)
: (string) Returned if `title` is omitted.
]]
function methods:GetTitle(title)
    mixin_helper.assert_argument_type(2, title, "nil", "FCString")

    local do_return = false
    if not title then
        title = temp_str
        do_return = true
    end

    self:GetTitle__(title)

    if do_return then
        return title.LuaString
    end
end

--[[
% SetTitle

**[Fluid] [Override]**

Override Changes:
- Accepts Lua `string` or `number` in addition to `FCString`.

@ self (__FCMUserWindow)
@ title (FCString | string | number)
]]
function methods:SetTitle(title)
    mixin_helper.assert_argument_type(2, title, "string", "number", "FCString")

    self:SetTitle__(mixin_helper.to_fcstring(title, temp_str))
end

--[[
% SetTitleLocalized

Localized version of `SetTitle`.

**[Fluid] [Override]**

@ self (__FCMUserWindow)
@ title (FCString | string | number)
]]
methods.SetTitleLocalized = mixin_helper.create_localized_proxy("SetTitle")

--[[
% CreateChildUI

**[Override]**

Override Changes:
- Returns original `CreateChildUI` if the method exists, otherwise it returns `mixin.UI()`

@ self (__FCMUserWindow)
: (FCMUI)
]]
function methods:CreateChildUI()
    if self.CreateChildUI__ then
        return self:CreateChildUI__()
    end

    return mixin.UI()
end

return class