jigi-33/wxpython_notes.md

WxPython notes

Вся документация подробно на https://docs.wxpython.org

Другие функции для объектов Фрейма / Окна:

Close() - закрывает окно
Maximize() - разворачивает полностью
Move(x, y) - сдвигает со смещением x,y пикселей от верхнего левого угла экрана или от предыдущего значения
SetPosition(pt:wx.Point) - помещает окно с начальной точкой pt, пример wnd.SetPosition(wx.Point(100,500))
SetSize(x, y, width, height) - устанавливает и позицию, и размер окна одной командой

Общая структура и типовая компоновка оконного интерфейса приложения. Классификация виджетов.

     Структура GUI-App'а: виджеты + Лэйауты.
     
     Layouts - схемы расположения элементов-виджетов.
     Panel -> Sizers - структурные элементы лэйаутов.
     
     Сайзеры бывают BoxSizer, GridSizer, FlexGridSizer, GridBagSizer
     
     Внутри одного сайзера могут располагаться и другие сайзеры.
     Пример других виджетов на фрейме: MenuBar, ToolBar, StatusBar.

Кроме класса Frame есть еще несколько полезных виджетов-панелей:

PopupWindow - специальный оконный класс для создания popup-меню, списков combobox и других вспомогательных виджетов подобного рода
ScrolledWindow - используется для создания окна с прокручиваемым содержимым
Frame - используется для создания стандартного окна в большинстве случаев работаем с ним
MDIParentFrame (Multiple Document Interface) - класс, содержащий дочерние оконные классы например, Photoshop со множеством открытых документов)
MDIChildFrame - создает дочернее окно внутри MDIParentFrame
Dialog - создает диалоговое окно

Имеются еще сложносоставные(специализированные) панели:

ScrolledWindow - контейнер с прокручиваемым содержимым
SplitterWindow - контейнер с разделительной полосой, которую можно перемещать, изменяя размеры соответствующих содержимых
Notebook - используется для создания tab-интерфейса (панели со вкладками)

Базовые группы виджетов:

I - ДИНАМИЧЕСКИЕ

Button - обычная кнопка
BitmapButton - кнопка с картинкой
ToggleButton - кнопка-переключатель
SpinButton - стрелочки вверх-вниз
RadioButton - радио-кнопка (кружочек с точкой)
CheckBox - чекбокс (флажок)
TextCtrl - текстовое поле ввода
SpinCtrl - текстовое поле ввода со стрелочками вверх-вниз
ComboBox - выпадающий список с возможностью ввода значения
Choice - выпадающий список только с возможностью выбора из предложенных
Slider - бегунок
ScrollBar - скроллинг
Grid - таблица (наподобие Excel)
RadioBox - контейнер для Радио-кнопок
ListBox - список

II - СТАТИЧЕСКИЕ

StaticBitmap - для статических изображений
StaticBox - квадратная рамка
Gauge - прогресс-бар
StaticText - простой (неизменяемый) текст
StaticLine - линия

Создание меню и подменю в wxPython. Обработчики событий (handlers) и метод связки - Bind

Для создания меню используются три основных класса:

MenuBar - для создания панели меню
Menu - для создания вкладки меню
MenuItem - для создания отдельного пункта внутри вкладки

Для связки назначенных на окне пунктов с их обработчиками существует метод Bind:

Bind(event, handler, source=None), где:

event - тип события, связанный с определенным интерфейсным объектом
handler - ссылка на функцию-обработчик
source - источник, генерирующий событие

Какие пункты меню существуют в wxPython (ключик: kind):

ITEM_NORMAL - обычный, как текст
ITEM_SEPARATOR - разделитель
ITEM_CHECK - пункт с флажком (чекбокс)
ITEM_RADIO - пункт с возможностью перебора

Создание контекстных меню и тулбара (панели инструментов)

Для формирования конт. меню нам нужно научить реагировать на правый клик мыши при Bind'инге.

Контекстное меню правильно будет описать отдельным классом вне класса MyFrame. Например, class AppContextMenu(wx.Menu).

Контекстное меню описывается как обычная вкладка меню для группы айтемов.

Какие еще бывают ивенты, кроме описанного в примере EVT_RIGHT_DOWN (правого клика мыши): https://docs.wxpython.org/wx.Event.html

Последовательность создания тулбара(панели инструментов):

self.CreateToolBar() - создание "пустого" тулбара
.AddTool() - добавление инструмента на тулбаре
.Realize() - воплощение(отрисовка) тулбара со всеми инструментами

И далее не забудем забиндить каждый пункт тулбара на свою функцию-обработчик (ч/з .Bind)

Доп. инфа по тулбарам в оф.документации https://docs.wxpython.org/wx.ToolBar.html

Схемы (layouts) размещения виджетов в окне

Сайзеры - разновидности виджетов. Бывают нескольких видов - BoxSizer, GridSizer, FlexGridSizer, GridBagSizer

BoxSizer - основной сайзер:

Наиболее применимый сайзер, BoxSizer - это аналог BoxLayout в Kivy или PyQt5, Лучшая практика - размещать в конечном итоге сайзеры на панели (мастер-лэйауте), а панель единственную на главном фрейме. Панель - аналог main layout'а в указанных выше GUI-фреймворках. Описывается панель примерно как: panel = wx.Panel(self), потом img1 и img2 натягиваются на панель, и в завершении пишется panel.SetSizer(vbox), т.е. устанавливаем сайзер не на фрейм, а на предварительно созданную панель (см. код видео 5_1)

GridSizer:

GridSizer позволяет создавать двухмерную сетку ячеек с одинаковой шириной и высотой.

Синтаксис:

wx.GridSizer(rows=1, cols=0, vgap=0, hgap=0)

rows - число строк (отсчет начинается с 1)
cols - число столбцов (отсчет идет с 0)
vgap - интервал между ячейками по вертикали
hgap - интервал между ячейкми по горизонтали

FlexGridSizer:

FlexGridSizer работает аналогично GridSizer'у, но ширина ячеек у мего м.б. разная.

Синтаксис и пример:

flexbox = wx.FlexGridSizer(4, 2, 10, 10)

flexbox.AddMany([
                (wx.StaticText(panel, label='ФИО:')),
                (wx.TextCtrl(panel), wx.ID_ANY, wx.EXPAND),
                (wx.StaticText(panel, label='email:')),
                (wx.TextCtrl(panel), wx.ID_ANY, wx.EXPAND),
                (wx.StaticText(panel, label='Адрес:')),
                (wx.TextCtrl(panel), wx.ID_ANY, wx.EXPAND),
                (wx.StaticText(panel, label='О себе:')),
                (wx.TextCtrl(panel, style=wx.NB_MULTILINE), wx.ID_ANY, wx.EXPAND),
                ])
panel.SetSizer(flexbox)

flexbox.AddGrowableCol(1, proportion=1)  # делается, чтобы поля ввода по опр. столбцы растягивались по ширине
flexbox.AddGrowableRow(3, proportion=1)  # первый параметр - номер строки

GridBagSizer:

GridBagSizer наиболее гибкий сайзер, он динамически создает таблички из ячеек, у кот-х м.быть разные размеры.

Синтаксис:

wx.GridBagSizer(vgap, hgap)

где параметры - расстояния между ячейками в px, по вертикали и горизонтали, а затем вызывается метод:

Add(self, item, pos, span=wx.DefaultSpan, flag=0, border=0, userData=None), где pos=(row, col)

Пример:

gbagbox = wx.GridBagSizer(5, 5)

lbl = wx.StaticText(panel, label = 'Email:')
gbagbox.Add(lbl, pos=(0, 0), flag=wx.TOP | wx.LEFT | wx.BOTTOM, border=5)  # (0, 0) # первая ячейка

txt_box = wx.TextCtrl(panel)
gbagbox.Add(txt_box, pos=(1, 0), span=(1, 5), flag=wx.EXPAND | wx.LEFT | wx.RIGHT, border=5)
# где span(1, 5) означает, что эта 1 строка будет охватывать 5 столбцов

btn1 = wx.Button(panel, label='Восстановить', size=(120, 28))
btn2 = wx.Button(panel, label='Отмена', size=(90, 28))
gbagbox.Add(btn1, pos=(3, 3))  # 4-я строка и 4-й столбец
gbagbox.Add(btn2, pos=(3, 4), flag=wx.RIGHT | wx.BOTTOM, border=10)
gbagbox.AddGrowableCol(col=1)  # при этом интерфейс будет растягиваться по максимуму

Механизм обработки событий: Bind / Unbind

Для каждого События(event'а) имеется свой заготовленный по умолчанию id:

wx.EVT_BUTTON - соб., генерируемое вилджетом wx.Button
wx.EVT_MENU - соб., генерируемое меню
wx.EVT_TEXT - соб., генерируемое wx.TextCtrl
wx.EVT_TOOL - соб., генерируемое toolbox (тулбаром)
wx.EVT_MOVE - соб., генерируемое при перемещении окна
wx.EVT_PAINT - соб. для перерисовки элемента (обычно окна)
wx.EVT_KEY_DOWN - соб. при нажатии на клавишу
wx.EVT_KEY_UP - соб. при отпускании клавиши

Синтаксис Bind для связки метода класса и какого-либо события:

объект.Bind(<тип события>, <метод>)

По умолчанию события рапространяются к родительским объектам с детей (такой концепт) однако есть еще такие basic events, при которых не распространяются по родительским объектам например: wx.EVT_CLOSE - действуют только для этого виджета

Обратный метод - Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY, handler=None)

Он сбрасывает(отвязывает) какой-либо обработчик от объекта; пример:

panel.Unbind(wx.EVT_BUTTON)