class Page(WizardPage):
## Constructor
#
# \param parent
# Parent <b><i>wx.Window</i></b> instance
def __init__(self, parent):
WizardPage.__init__(self, parent, pgid.CHANGELOG)
txt_package = wx.StaticText(self,
label=GT(u'Package'),
name=u'package')
self.ti_package = TextArea(self,
inputid.PACKAGE,
name=txt_package.Name)
txt_version = wx.StaticText(self,
label=GT(u'Version'),
name=u'version')
self.ti_version = TextArea(self,
inputid.VERSION,
name=txt_version.Name)
dist_names = GetOSDistNames()
txt_dist = wx.StaticText(self, label=GT(u'Distribution'), name=u'dist')
if dist_names:
self.ti_dist = ComboBox(self,
inputid.DIST,
choices=dist_names,
name=txt_dist.Name)
# Use regular text input if could not retrieve distribution names list
else:
self.ti_dist = TextArea(self, inputid.DIST, name=txt_dist.Name)
opts_urgency = (
u'low',
u'medium',
u'high',
u'emergency',
)
txt_urgency = wx.StaticText(self,
label=GT(u'Urgency'),
name=u'urgency')
self.sel_urgency = Choice(self,
selid.URGENCY,
choices=opts_urgency,
name=txt_urgency.Name)
txt_maintainer = wx.StaticText(self,
label=GT(u'Maintainer'),
name=u'maintainer')
self.ti_maintainer = TextArea(self,
inputid.MAINTAINER,
name=txt_maintainer.Name)
txt_email = wx.StaticText(self, label=GT(u'Email'), name=u'email')
self.ti_email = TextArea(self, inputid.EMAIL, name=txt_email.Name)
btn_import = CreateButton(self,
btnid.IMPORT,
GT(u'Import'),
u'import',
name=u'btn import')
txt_import = wx.StaticText(
self, label=GT(u'Import information from Control page'))
# Changes input
self.ti_changes = TextAreaPanel(self, size=(20, 150), name=u'changes')
# *** Target installation directory
# FIXME: Should this be set by config or project file???
self.pnl_target = FileOTarget(self,
u'/usr/share/doc/<package>',
name=u'target default',
defaultType=CheckBoxESS,
customType=PathCtrlESS,
pathIds=(
chkid.TARGET,
inputid.TARGET,
))
self.btn_add = CreateButton(self,
btnid.ADD,
GT(u'Add'),
u'add',
name=u'btn add')
txt_add = wx.StaticText(self, label=GT(u'Insert new changelog entry'))
self.chk_indentation = CheckBox(self,
label=GT(u'Preserve indentation'),
name=u'indent')
self.dsp_changes = TextAreaPanelESS(self,
inputid.CHANGES,
monospace=True,
name=u'log')
self.dsp_changes.EnableDropTarget()
SetPageToolTips(self)
# *** Event Handling *** #
btn_import.Bind(wx.EVT_BUTTON, self.OnImportFromControl)
self.btn_add.Bind(wx.EVT_BUTTON, self.AddInfo)
# *** Layout *** #
LEFT_BOTTOM = lyt.ALGN_LB
LEFT_CENTER = wx.ALIGN_LEFT | wx.ALIGN_CENTER_VERTICAL
RIGHT_CENTER = wx.ALIGN_RIGHT | wx.ALIGN_CENTER_VERTICAL
lyt_info = wx.FlexGridSizer(2, 6)
lyt_info.AddGrowableCol(1)
lyt_info.AddGrowableCol(3)
lyt_info.AddGrowableCol(5)
lyt_info.AddMany(
((txt_package, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_package, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_version, 0, RIGHT_CENTER | wx.RIGHT, 5),
(self.ti_version, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_dist, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_dist, 1, wx.EXPAND | wx.BOTTOM,
5), (txt_urgency, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.sel_urgency, 1, wx.RIGHT, 5),
(txt_maintainer, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_maintainer, 1, wx.EXPAND | wx.RIGHT,
5), (txt_email, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_email, 1, wx.EXPAND)))
lyt_details = wx.GridBagSizer()
lyt_details.SetCols(3)
lyt_details.AddGrowableRow(2)
lyt_details.AddGrowableCol(1)
lyt_details.Add(btn_import, (0, 0))
lyt_details.Add(txt_import, (0, 1), flag=LEFT_CENTER)
lyt_details.Add(wx.StaticText(self, label=GT(u'Changes')), (1, 0),
flag=LEFT_BOTTOM)
lyt_details.Add(wx.StaticText(self, label=GT(u'Target')), (1, 2),
flag=LEFT_BOTTOM)
lyt_details.Add(self.ti_changes, (2, 0), (1, 2), wx.EXPAND | wx.RIGHT,
5)
lyt_details.Add(self.pnl_target, (2, 2))
lyt_details.Add(self.btn_add, (3, 0), (2, 1))
lyt_details.Add(txt_add, (3, 1), flag=LEFT_BOTTOM | wx.TOP, border=5)
lyt_details.Add(self.chk_indentation, (4, 1), flag=LEFT_BOTTOM)
lyt_main = BoxSizer(wx.VERTICAL)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_info, 0, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_details, 1, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.Add(wx.StaticText(self, label=u'Changelog Output'), 0,
LEFT_BOTTOM | lyt.PAD_LT, 5)
lyt_main.Add(self.dsp_changes, 1, wx.EXPAND | lyt.PAD_LR | wx.BOTTOM,
5)
self.SetAutoLayout(True)
self.SetSizer(lyt_main)
self.Layout()
## Formats input text from 'changes' field for new entry in changelog
def AddInfo(self, event=None):
new_changes = self.ti_changes.GetValue()
if TextIsEmpty(new_changes):
DetailedMessageDialog(
GetMainWindow(), GT(u'Warning'), ICON_WARNING,
GT(u'"Changes" section is empty')).ShowModal()
self.ti_changes.SetInsertionPointEnd()
self.ti_changes.SetFocus()
return
package = self.ti_package.GetValue()
version = self.ti_version.GetValue()
dist = self.ti_dist.GetValue()
urgency = self.sel_urgency.GetStringSelection()
maintainer = self.ti_maintainer.GetValue()
email = self.ti_email.GetValue()
new_changes = FormatChangelog(new_changes, package, version, dist,
urgency, maintainer, email,
self.chk_indentation.GetValue())
# Clean up leading & trailing whitespace in old changes
old_changes = self.dsp_changes.GetValue().strip(u' \t\n\r')
# Only append newlines if log isn't already empty
if not TextIsEmpty(old_changes):
new_changes = u'{}\n\n\n{}'.format(new_changes, old_changes)
# Add empty line to end of log
if not new_changes.endswith(u'\n'):
new_changes = u'{}\n'.format(new_changes)
self.dsp_changes.SetValue(new_changes)
# Clear "Changes" text
self.ti_changes.Clear()
self.ti_changes.SetFocus()
## Retrieves changelog text
#
# The output is a text file that uses sections defined by braces ([, ])
#
# \return
# <b><i>tuple(str, str)</i></b>: Filename & formatted string of changelog target & body
def Get(self):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'STANDARD'
return (target, self.GetChangelog())
## Retrieves plain text of the changelog field
#
# \return
# Formatted changelog text
def GetChangelog(self):
return self.dsp_changes.GetValue()
## TODO: Doxygen
def GetSaveData(self):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'<<DEST>>DEFAULT<</DEST>>'
else:
target = u'<<DEST>>{}<</DEST>>'.format(target)
return u'\n'.join((u'<<CHANGELOG>>', target,
self.dsp_changes.GetValue(), u'<</CHANGELOG>>'))
## Checks the page's fields for exporting
#
# \return
# <b><i>False</i></b> if page cannot be exported
def IsOkay(self):
return not TextIsEmpty(self.dsp_changes.GetValue())
## Imports select field values from the 'Control' page
def OnImportFromControl(self, event=None):
fields = (
(self.ti_package, inputid.PACKAGE),
(self.ti_version, inputid.VERSION),
(self.ti_maintainer, inputid.MAINTAINER),
(self.ti_email, inputid.EMAIL),
)
for F, FID in fields:
field_value = GetFieldValue(pgid.CONTROL, FID)
if isinstance(field_value, ErrorTuple):
err_msg1 = GT(
u'Got error when attempting to retrieve field value')
err_msg2 = u'\tError code: {}\n\tError message: {}'.format(
field_value.GetCode(), field_value.GetString())
Logger.Error(__name__, u'{}:\n{}'.format(err_msg1, err_msg2))
continue
if not TextIsEmpty(field_value):
F.SetValue(field_value)
## Sets values of page's fields with given input
#
# \param data
# Text to parse for values
def Set(self, data):
changelog = data.split(u'\n')
target = changelog[0].split(u'<<DEST>>')[1].split(u'<</DEST>>')[0]
if target == u'DEFAULT':
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
self.pnl_target.SetPath(target)
self.dsp_changes.SetValue(u'\n'.join(changelog[1:]))
class Page(WizardPage):
## Constructor
#
# \param parent
# Parent <b><i>wx.Window</i></b> instance
def __init__(self, parent):
WizardPage.__init__(self, parent, pgid.CHANGELOG)
txt_package = wx.StaticText(self,
label=GT(u'Package'),
name=u'package')
self.ti_package = TextArea(self,
inputid.PACKAGE,
name=txt_package.Name)
txt_version = wx.StaticText(self,
label=GT(u'Version'),
name=u'version')
self.ti_version = TextArea(self,
inputid.VERSION,
name=txt_version.Name)
dist_names = GetOSDistNames()
txt_dist = wx.StaticText(self, label=GT(u'Distribution'), name=u'dist')
if dist_names:
self.ti_dist = ComboBox(self,
inputid.DIST,
choices=dist_names,
name=txt_dist.Name)
# Use regular text input if could not retrieve distribution names list
else:
self.ti_dist = TextArea(self, inputid.DIST, name=txt_dist.Name)
opts_urgency = (
u'low',
u'medium',
u'high',
u'emergency',
)
txt_urgency = wx.StaticText(self,
label=GT(u'Urgency'),
name=u'urgency')
self.sel_urgency = Choice(self,
selid.URGENCY,
choices=opts_urgency,
name=txt_urgency.Name)
txt_maintainer = wx.StaticText(self,
label=GT(u'Maintainer'),
name=u'maintainer')
self.ti_maintainer = TextArea(self,
inputid.MAINTAINER,
name=txt_maintainer.Name)
txt_email = wx.StaticText(self, label=GT(u'Email'), name=u'email')
self.ti_email = TextArea(self, inputid.EMAIL, name=txt_email.Name)
btn_import = CreateButton(self,
btnid.IMPORT,
GT(u'Import'),
u'import',
name=u'btn import')
txt_import = wx.StaticText(
self, label=GT(u'Import information from Control page'))
# Changes input
self.ti_changes = TextAreaPanel(self, size=(20, 150), name=u'changes')
# *** Target installation directory
# FIXME: Should this be set by config or project file???
self.pnl_target = FileOTarget(self,
u'/usr/share/doc/<package>',
name=u'target default',
defaultType=CheckBoxESS,
customType=PathCtrlESS,
pathIds=(
chkid.TARGET,
inputid.TARGET,
))
self.btn_add = CreateButton(self,
btnid.ADD,
GT(u'Add'),
u'add',
name=u'btn add')
txt_add = wx.StaticText(self, label=GT(u'Insert new changelog entry'))
self.chk_indentation = CheckBox(self,
label=GT(u'Preserve indentation'),
name=u'indent')
self.dsp_changes = TextAreaPanelESS(self,
inputid.CHANGES,
monospace=True,
name=u'log')
self.dsp_changes.EnableDropTarget()
SetPageToolTips(self)
# *** Event Handling *** #
btn_import.Bind(wx.EVT_BUTTON, self.OnImportFromControl)
self.btn_add.Bind(wx.EVT_BUTTON, self.AddInfo)
# *** Layout *** #
LEFT_BOTTOM = lyt.ALGN_LB
LEFT_CENTER = wx.ALIGN_LEFT | wx.ALIGN_CENTER_VERTICAL
RIGHT_CENTER = wx.ALIGN_RIGHT | wx.ALIGN_CENTER_VERTICAL
lyt_info = wx.FlexGridSizer(2, 6)
lyt_info.AddGrowableCol(1)
lyt_info.AddGrowableCol(3)
lyt_info.AddGrowableCol(5)
lyt_info.AddMany(
((txt_package, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_package, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_version, 0, RIGHT_CENTER | wx.RIGHT, 5),
(self.ti_version, 1, wx.EXPAND | wx.BOTTOM | wx.RIGHT,
5), (txt_dist, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_dist, 1, wx.EXPAND | wx.BOTTOM,
5), (txt_urgency, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.sel_urgency, 1, wx.RIGHT, 5),
(txt_maintainer, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_maintainer, 1, wx.EXPAND | wx.RIGHT,
5), (txt_email, 0, RIGHT_CENTER | wx.RIGHT,
5), (self.ti_email, 1, wx.EXPAND)))
lyt_details = wx.GridBagSizer()
lyt_details.SetCols(3)
lyt_details.AddGrowableRow(2)
lyt_details.AddGrowableCol(1)
lyt_details.Add(btn_import, (0, 0))
lyt_details.Add(txt_import, (0, 1), flag=LEFT_CENTER)
lyt_details.Add(wx.StaticText(self, label=GT(u'Changes')), (1, 0),
flag=LEFT_BOTTOM)
lyt_details.Add(wx.StaticText(self, label=GT(u'Target')), (1, 2),
flag=LEFT_BOTTOM)
lyt_details.Add(self.ti_changes, (2, 0), (1, 2), wx.EXPAND | wx.RIGHT,
5)
lyt_details.Add(self.pnl_target, (2, 2))
lyt_details.Add(self.btn_add, (3, 0), (2, 1))
lyt_details.Add(txt_add, (3, 1), flag=LEFT_BOTTOM | wx.TOP, border=5)
lyt_details.Add(self.chk_indentation, (4, 1), flag=LEFT_BOTTOM)
lyt_main = BoxSizer(wx.VERTICAL)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_info, 0, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.AddSpacer(10)
lyt_main.Add(lyt_details, 1, wx.EXPAND | lyt.PAD_LR, 5)
lyt_main.Add(wx.StaticText(self, label=u'Changelog Output'), 0,
LEFT_BOTTOM | lyt.PAD_LT, 5)
lyt_main.Add(self.dsp_changes, 1, wx.EXPAND | lyt.PAD_LR | wx.BOTTOM,
5)
self.SetAutoLayout(True)
self.SetSizer(lyt_main)
self.Layout()
## Formats input text from 'changes' field for new entry in changelog
def AddInfo(self, event=None):
new_changes = self.ti_changes.GetValue()
if TextIsEmpty(new_changes):
DetailedMessageDialog(
GetMainWindow(), GT(u'Warning'), ICON_WARNING,
GT(u'"Changes" section is empty')).ShowModal()
self.ti_changes.SetInsertionPointEnd()
self.ti_changes.SetFocus()
return
package = self.ti_package.GetValue()
version = self.ti_version.GetValue()
dist = self.ti_dist.GetValue()
urgency = self.sel_urgency.GetStringSelection()
maintainer = self.ti_maintainer.GetValue()
email = self.ti_email.GetValue()
new_changes = FormatChangelog(new_changes, package, version, dist,
urgency, maintainer, email,
self.chk_indentation.GetValue())
# Clean up leading & trailing whitespace in old changes
old_changes = self.dsp_changes.GetValue().strip(u' \t\n\r')
# Only append newlines if log isn't already empty
if not TextIsEmpty(old_changes):
new_changes = u'{}\n\n\n{}'.format(new_changes, old_changes)
# Add empty line to end of log
if not new_changes.endswith(u'\n'):
new_changes = u'{}\n'.format(new_changes)
self.dsp_changes.SetValue(new_changes)
# Clear "Changes" text
self.ti_changes.Clear()
self.ti_changes.SetFocus()
## Exports page's data to file
#
# \param out_dir
# Target directory where file will be written
# \out_name
# Filename of output file
# \compress
# If <b><i>True</i></b>, compresses file with gzip
def Export(self, out_dir, out_name=wx.EmptyString, compress=False):
ret_value = WizardPage.Export(self, out_dir, out_name=out_name)
absolute_filename = u'{}/{}'.format(out_dir,
out_name).replace(u'//', u'/')
CMD_gzip = GetExecutable(u'gzip')
if compress and CMD_gzip:
commands.getstatusoutput(u'{} -n9 "{}"'.format(
CMD_gzip, absolute_filename))
return ret_value
## Export instructions specifically for build phase
#
# \param stage
# Formatted staged directory where file heirarchy is temporarily kept
# \return
# <b><i>Tuple</i></b> containing a return code & string value of page data
def ExportBuild(self, stage):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target.replace(u'<package>',
GetFieldValue(pgid.CONTROL, inputid.PACKAGE))
stage = ConcatPaths((stage, target))
if not os.path.isdir(stage):
os.makedirs(stage)
# FIXME: Allow user to set filename
self.Export(stage, u'changelog', True)
export_summary = GT(u'Changelog export failed')
changelog = ConcatPaths((stage, u'changelog.gz'))
if os.path.isfile(changelog):
export_summary = GT(u'Changelog export to: {}').format(changelog)
return (0, export_summary)
## Retrieves changelog text
#
# The output is a text file that uses sections defined by braces ([, ])
#
# \param getModule
# If <b><i>True</i></b>, returns a <b><i>tuple</b></i> of the module name
# & page data, otherwise return only page data string
# \return
# <b><i>tuple(str, str)</i></b>: Filename & formatted string of changelog target & body
def Get(self, getModule=False):
target = self.pnl_target.GetPath()
if target == self.pnl_target.GetDefaultPath():
target = u'DEFAULT'
body = self.dsp_changes.GetValue()
if TextIsEmpty(body):
page = None
else:
page = u'[TARGET={}]\n\n[BODY]\n{}'.format(target, body)
if getModule:
page = (
__name__,
page,
)
return page
## Retrieves plain text of the changelog field
#
# \return
# Formatted changelog text
def GetChangelog(self):
return self.dsp_changes.GetValue()
## Reads & parses page data from a formatted text file
#
# \param filename
# File path to open
def ImportFromFile(self, filename):
if not os.path.isfile(filename):
return dbrerrno.ENOENT
clog_data = ReadFile(filename, split=True)
sections = {}
def parse_section(key, lines):
value = u'\n'.join(lines).split(u'\n[')[0]
if u'=' in key:
key = key.split(u'=')
value = (key[-1], value)
key = key[0]
sections[key] = value
# NOTE: This would need to be changed were more sections added to project file
for L in clog_data:
line_index = clog_data.index(L)
if not TextIsEmpty(L) and u'[' in L and u']' in L:
L = L.split(u'[')[-1].split(u']')[0]
parse_section(L, clog_data[line_index + 1:])
for S in sections:
Logger.Debug(
__name__,
GT(u'Changelog section: "{}", Value:\n{}').format(
S, sections[S]))
if isinstance(sections[S], (tuple, list)):
value_index = 0
for I in sections[S]:
Logger.Debug(__name__,
GT(u'Value {}: {}').format(value_index, I))
value_index += 1
if S == u'TARGET':
Logger.Debug(__name__, u'SECTION TARGET FOUND')
if sections[S][0] == u'DEFAULT':
Logger.Debug(__name__, u'Using default target')
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
Logger.Debug(
__name__,
GT(u'Using custom target: {}').format(sections[S][0]))
self.pnl_target.SetPath(sections[S][0])
continue
if S == u'BODY':
Logger.Debug(__name__, u'SECTION BODY FOUND')
self.dsp_changes.SetValue(sections[S])
continue
return 0
## Checks the page's fields for exporting
#
# \return
# <b><i>False</i></b> if page cannot be exported
def IsOkay(self):
return not TextIsEmpty(self.dsp_changes.GetValue())
## Imports select field values from the 'Control' page
def OnImportFromControl(self, event=None):
fields = (
(self.ti_package, inputid.PACKAGE),
(self.ti_version, inputid.VERSION),
(self.ti_maintainer, inputid.MAINTAINER),
(self.ti_email, inputid.EMAIL),
)
for F, FID in fields:
field_value = GetFieldValue(pgid.CONTROL, FID)
if isinstance(field_value, ErrorTuple):
err_msg1 = GT(
u'Got error when attempting to retrieve field value')
err_msg2 = u'\tError code: {}\n\tError message: {}'.format(
field_value.GetCode(), field_value.GetString())
Logger.Error(__name__, u'{}:\n{}'.format(err_msg1, err_msg2))
continue
if not TextIsEmpty(field_value):
F.SetValue(field_value)
## Sets values of page's fields with given input
#
# \param data
# Text to parse for values
def Set(self, data):
changelog = data.split(u'\n')
target = changelog[0].split(u'<<DEST>>')[1].split(u'<</DEST>>')[0]
if target == u'DEFAULT':
if not self.pnl_target.UsingDefault():
self.pnl_target.Reset()
else:
self.pnl_target.SetPath(target)
self.dsp_changes.SetValue(u'\n'.join(changelog[1:]))
class DetailedMessageDialog(BaseDialog, ButtonDialog):
def __init__(self,
parent,
title=GT(u'Message'),
icon=ICON_INFORMATION,
text=wx.EmptyString,
details=wx.EmptyString,
style=wx.DEFAULT_DIALOG_STYLE,
buttons=(wx.ID_OK, ),
linewrap=0):
BaseDialog.__init__(self, parent, wx.ID_ANY, title, style=style)
# Allow using strings for 'icon' argument
if isinstance(icon, (unicode, str)):
icon = wx.Bitmap(icon)
icon = wx.StaticBitmap(self, wx.ID_ANY, icon)
txt_message = wx.StaticText(self, label=text)
if linewrap:
txt_message.Wrap(linewrap)
# self.details needs to be empty for constructor
self.details = wx.EmptyString
details = details
# *** Layout *** #
self.lyt_urls = BoxSizer(wx.VERTICAL)
# Only set if buttons are added to dialog
self.lyt_buttons = None
lyt_main = wx.GridBagSizer(5, 5)
lyt_main.SetCols(3)
lyt_main.AddGrowableRow(3)
lyt_main.AddGrowableCol(2)
lyt_main.Add(icon, (0, 0), (5, 1),
wx.ALIGN_TOP | lyt.PAD_LR | wx.BOTTOM, 20)
lyt_main.Add(txt_message, (0, 1), (1, 2), lyt.PAD_RT, 20)
lyt_main.Add(self.lyt_urls, (1, 1), (1, 2), wx.RIGHT, 5)
self.SetAutoLayout(True)
self.SetSizer(lyt_main)
self.AddButtons(buttons)
if not TextIsEmpty(details):
# self.details will be set here
self.CreateDetailedView(details)
else:
self.Layout()
self.Fit()
self.SetMinSize(self.GetSize())
self.CenterOnParent()
## Add custom buttons to dialog
#
# NOTE: Do not call before self.SetSizer
#
# FIXME: Rename to SetButtons???
# FIXME: Should delete any previous buttons
def AddButtons(self, button_ids):
self.lyt_buttons = AddCustomButtons(self, button_ids)
self.Sizer.Add(self.lyt_buttons, (4, 2),
flag=wx.ALIGN_RIGHT | wx.ALIGN_BOTTOM | lyt.PAD_RTB,
border=5)
## Adds a clickable link to the dialog
def AddURL(self, url):
if not isinstance(url, Hyperlink):
url = Hyperlink(self, wx.ID_ANY, label=url, url=url)
self.lyt_urls.Add(url, 0, wx.ALIGN_CENTER_VERTICAL)
self.Layout()
self.Fit()
self.SetMinSize(self.GetSize())
self.CenterOnParent()
## Shows dialog modal & returns 'confirmed' value
#
# \return
# \b \e bool : True if ShowModal return value one of wx.ID_OK, wx.OK, wx.ID_YES, wx.YES
def Confirmed(self):
return self.ShowModal() in (wx.ID_OK, wx.OK, wx.ID_YES, wx.YES)
## Adds buttons & details text to dialog
#
# \param details
# \b \e unicode|str : Detailed text to show in dialog
def CreateDetailedView(self, details):
# Controls have not been constructed yet
if TextIsEmpty(self.details):
self.btn_details = wx.ToggleButton(self, label=GT(u'Details'))
#btn_copy = wx.Button(self, label=GT(u'Copy details'))
self.dsp_details = TextAreaPanel(self,
value=details,
style=wx.TE_READONLY)
# *** Event handlers *** #
self.btn_details.Bind(wx.EVT_TOGGLEBUTTON, self.ToggleDetails)
#btn_copy.Bind(wx.EVT_BUTTON, self.OnCopyDetails)
layout = self.GetSizer()
layout.Add(self.btn_details, (2, 1))
#layout.Add(btn_copy, (2, 2), flag=wx.ALIGN_LEFT|wx.RIGHT, border=5)
layout.Add(self.dsp_details, (3, 1), (1, 2), wx.EXPAND | wx.RIGHT,
5)
self.ToggleDetails()
if not TextIsEmpty(details):
for C in self.GetChildren():
if isinstance(C, TextAreaPanel):
self.details = details
C.SetValue(self.details)
return True
return False
## Attempts to retrieve button instance matching btn_id
#
# FIXME: This will fail if there are standard buttons in the dialog
# FIXME: Retrieving by label doesn't work
# \param btn_id
# ID of the button instance to retrieve
# \return
# \b \e wx.Button instance or None
def GetButton(self, btn_id):
# Allow search by label
use_label = not isinstance(btn_id, int)
if self.lyt_buttons:
for sizer in self.lyt_buttons.GetChildren():
sizer = sizer.GetSizer()
btn_layout = sizer.GetChildren()
if btn_layout:
BTN = btn_layout[0].GetWindow()
LBL = None
if len(btn_layout) < 2 and isinstance(BTN, wx.Button):
LBL = BTN.GetLabel()
else:
LBL = btn_layout[1]
if isinstance(LBL, wx.StaticText):
LBL = LBL.GetLabel()
if not use_label:
if BTN.GetId() == btn_id:
return BTN
else:
if LBL == btn_id:
return BTN
## TODO: Doxygen
#
# FIXME: Layout initially wrong
# TODO: Allow copying details to clipboard
def OnCopyDetails(self, event=None):
print(u'DEBUG: Copying details to clipboard ...')
DetailedMessageDialog(
self, u'FIXME', ICON_EXCLAMATION,
u'Copying details to clipboard not functional').ShowModal()
return
cb_set = False
clipboard = wx.Clipboard()
if clipboard.Open():
print(u'DEBUG: Clipboard opened')
details = wx.TextDataObject(self.dsp_details.GetValue())
print(u'DEBUG: Details set to:\n{}'.format(details.GetText()))
clipboard.Clear()
print(u'DEBUG: Clipboard cleared')
cb_set = clipboard.SetData(details)
print(u'DEBUG: Clipboard data set')
clipboard.Flush()
print(u'DEBUG: Clipboard flushed')
clipboard.Close()
print(u'DEBUG: Clipboard cloased')
del clipboard
print(u'DEBUG: Clipboard object deleted')
wx.MessageBox(u'FIXME: Details not copied to clipboard', GT(u'Debug'))
## Override inherited method to center on parent window first
def ShowModal(self, *args, **kwargs):
if self.Parent:
self.CenterOnParent()
return wx.Dialog.ShowModal(self, *args, **kwargs)
## TODO: Doxygen
def SetDetails(self, details):
return self.CreateDetailedView(details)
## TODO: Doxygen
def ToggleDetails(self, event=None):
try:
if self.btn_details.GetValue():
self.dsp_details.Show()
else:
self.dsp_details.Hide()
self.Layout()
self.Fit()
self.SetMinSize(self.GetSize())
return True
except AttributeError:
# Disable toggling details
self.btn_details.Hide()
self.Layout()
self.Fit()
self.SetMinSize(self.GetSize())
return False