wxPython

https://github.com/wxwidgets/phoenix
Admin
wxPython is a cross-platform Python GUI toolkit that wraps the wxWidgets C++ library, enabling...
Tokens:122,111
Snippets:1,448
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Pip using get-pip.py

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/README-snapshots.txt

If you do not have pip installed, you can download and run the get-pip.py script. This is a common method for bootstrapping pip on a system.

```bash
wget https://bootstrap.pypa.io/get-pip.py
python get-pip.py
```

--------------------------------

### Install Requirements

Source: https://github.com/wxwidgets/phoenix/blob/master/README.rst

Installs the necessary project requirements before building. Ensure you have Python installed.

```bash
python -m pip install -r requirements.txt
```

--------------------------------

### GetHighlightGuide

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the highlighted indentation guide column.

```APIDOC
## GetHighlightGuide

### Description
Gets the highlighted indentation guide column.

### Method
GET

### Endpoint
/stc/indentation-guides/highlight

### Returns
- **int**: The column number of the highlighted guide.
```

--------------------------------

### SetHighlightGuide

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Sets the highlighted indentation guide column.

```APIDOC
## SetHighlightGuide

### Description
Sets the highlighted indentation guide column. 0 means no highlighted guide.

### Method
PUT

### Endpoint
/stc/indentation-guides/highlight

### Parameters
#### Query Parameters
- **column** (int) - Required - The column number for the highlighted guide.
```

--------------------------------

### Install wxPython via Pip

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Commands to install specific versions of the wxPython library using pip.

```bash
pip install wxPython==4.0.1
```

```bash
pip install wxPython==4.0.0
```

--------------------------------

### Install PyPubSub

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/MigrationGuide.rst

Install the PyPubSub package for Python 3 compatibility. Use a specific version for Python 2.7.

```bash
pip install -U PyPubSub==3.3.0
```

--------------------------------

### Install wxPython Snapshot for Linux (GTK3)

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/README-snapshots.txt

This command installs a wxPython snapshot build specifically for Linux, targeting GTK3 and Ubuntu 16.04. Adjust the URL for different Linux distributions or wx port versions.

```bash
pip install -U --pre \
    -f https://wxpython.org/Phoenix/snapshot-builds/linux/gtk3/ubuntu-16.04 \
    wxPython
```

--------------------------------

### Install Specific wxPython Snapshot Version

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/README-snapshots.txt

To install a specific development version, append the version number to the pip install command. Ensure the version number matches a build available in the snapshot repository.

```bash
pip install -U --pre \
    -f https://wxpython.org/Phoenix/snapshot-builds/ \
    wxPython==4.0.0a2.dev2973+5ff6be7
```

--------------------------------

### Install Latest wxPython Snapshot Build

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/README-snapshots.txt

Use this command to install the latest pre-release version of wxPython from the snapshot builds. Pip will automatically find the correct wheel if available for your system and Python version.

```bash
pip install -U --pre \
    -f https://wxpython.org/Phoenix/snapshot-builds/ \
    wxPython
```

--------------------------------

### Launch wxPython Phoenix Demo

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/README-sdist_demo.txt

Run the wxPython Phoenix demo application from the command line after installation.

```shell
cd demo
python demo.py
```

--------------------------------

### GetSelectionStart

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Returns the position at the start of the selection.

```APIDOC
## GetSelectionStart

### Description
Returns the position at the start of the selection.

### Method
GET

### Endpoint
/stc/selection/start

### Returns
- **int**: The starting position of the selection.
```

--------------------------------

### Example of reST Info Field List for a Method

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst

Demonstrates the use of :param:, :type:, :returns:, :rtype:, and :raise: fields to document a method's signature, behavior, and potential exceptions.

```rst
.. method:: Set3StateValue(self, state):

   Sets the checkbox item to the given `state`.

   :param `state`: can be one of: ``wx.CHK_UNCHECKED`` (check is
      off), ``wx.CHK_CHECKED`` (check is on) or
      ``wx.CHK_UNDETERMINED`` (check is mixed).
   :type `state`: integer

   :returns: ``True`` if the value was successfully set, ``False``
      otherwise.
   :rtype: bool

   :raise: `Exception` when the item is not a 3-state checkbox item.
```

--------------------------------

### Setup Translation Function in wxPython App

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/internationalization.rst

Initializes the translation function '_' and makes it available application-wide by adding it to builtins. This is part of the application setup for internationalization.

```Python
import gettext

_ = gettext.gettext
```

--------------------------------

### GetIndentationGuides

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Checks if indentation guides are visible.

```APIDOC
## GetIndentationGuides

### Description
Checks if the indentation guides are visible.

### Method
GET

### Endpoint
/stc/indentation-guides/visibility

### Returns
- **bool**: True if indentation guides are visible, false otherwise.
```

--------------------------------

### wx.ALL Border Flag Example

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

Demonstrates applying a uniform border on all sides of a control using the wx.ALL flag, specifying the pixel width for the border.

```python
sizer = wx.BoxSizer(wx.VERTICAL)
# Border size effects
sizer.Add(wx.Button(self, -1, "An extremely long button text"), 0, 0, 0)
sizer.Add(wx.Button(self, -1, "Small Button"), 0, wx.EXPAND | wx.ALL, 20)
sizer.SetSizeHints(self)
self.SetSizer(sizer)
```

--------------------------------

### SetIndentationGuides

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Shows or hides indentation guides.

```APIDOC
## SetIndentationGuides

### Description
Shows or hides indentation guides.

### Method
PUT

### Endpoint
/stc/indentation-guides/visibility

### Parameters
#### Query Parameters
- **show** (bool) - Required - True to show, false to hide.
```

--------------------------------

### Dialog with TextCtrl and Buttons using wx.SizerFlags

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

This example demonstrates the same dialog layout as the previous one, but utilizes the wx.SizerFlags class for a more concise and readable way to specify sizer properties.

```Python
class MyDialog(wx.Dialog):

    def __init__(self, parent, id, title):

        wx.Dialog(parent, id, title, wx.DefaultPosition, wx.DefaultSize,
                  wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)

        topsizer = wx.BoxSizer(wx.VERTICAL)

        # create text ctrl with minimal size 100x60
        topsizer.Add(
                wx.TextCtrl(self, -1, "My text.", wx.DefaultPosition, wx.Size(100,60), wx.TE_MULTILINE),
                wx.SizerFlags(1).Align().Expand().Border(wx.ALL, 10))

        button_sizer = wx.BoxSizer(wx.HORIZONTAL)
        button_sizer.Add(
                wx.Button(self, wx.ID_OK, "OK"),
                wx.SizerFlags(0).Align().Border(wx.ALL, 10))

        button_sizer.Add(
                wx.Button(self, wx.ID_CANCEL, "Cancel"),
                wx.SizerFlags(0).Align().Border(wx.ALL, 10))

        topsizer.Add(
                button_sizer,
                wx.SizerFlags(0).Center())

        self.SetSizerAndFit(topsizer) # use the sizer for layout and set size and hints

```

--------------------------------

### Create and Activate Python Virtual Environment

Source: https://github.com/wxwidgets/phoenix/blob/master/buildbot/README-bbworker.md

Sets up a Python virtual environment for the buildbot worker and installs necessary packages.

```bash
cd ~/.myPyEnv
python3.8 -m venv Py38-bb2
source Py38-bb2/bin/activate
pip install buildbot-worker
```

--------------------------------

### Creating and Using wx.ClientDC

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/dc_overview.rst

Example of creating a wx.ClientDC object to draw on a window's client area. This should be used outside of a wx.PaintEvent handler.

```Python
def OnMyCmd(self, event):
    dc = wx.ClientDC(window)
    DrawMyPicture(dc)
```

--------------------------------

### wx.LEFT and wx.RIGHT Border Flags Example

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

Shows how to apply borders to both the left and right sides of a control using wx.LEFT and wx.RIGHT flags, with a specified pixel width.

```python
sizer = wx.BoxSizer(wx.VERTICAL)
# Border size effects
sizer.Add(wx.Button(self, -1, "An extremely long button text"), 0, 0, 0)
sizer.Add(wx.Button(self, -1, "Small Button"), 0, wx.EXPAND | wx.LEFT | wx.RIGHT, 20)
sizer.SetSizeHints(self)
self.SetSizer(sizer)
```

--------------------------------

### Build All Docker Images

Source: https://github.com/wxwidgets/phoenix/blob/master/docker/README.rst

Builds all available Docker images. Requires the 'invoke' package to be installed.

```bash
inv build-images
```

--------------------------------

### Dialog with TextCtrl and Buttons using wx.Sizer

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

This example demonstrates creating a stretchable dialog with a text control and two buttons using wx.BoxSizer and the Add() method with border and alignment flags.

```Python
class MyDialog(wx.Dialog):

    def __init__(self, parent, id, title):

        wx.Dialog(parent, id, title, wx.DefaultPosition, wx.DefaultSize,
                  wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)

        topsizer = wx.BoxSizer(wx.VERTICAL)

        # create text ctrl with minimal size 100x60
        topsizer.Add(
                wx.TextCtrl(self, -1, "My text.", wx.DefaultPosition, wx.Size(100,60), wx.TE_MULTILINE),
                1,           # make vertically stretchable
                wx.EXPAND |  # make horizontally stretchable
                wx.ALL,      # and make border all around
                10)          # set border width to 10

        button_sizer = wx.BoxSizer(wx.HORIZONTAL)
        button_sizer.Add(
                wx.Button(self, wx.ID_OK, "OK"),
                0,           # make horizontally unstretchable
                wx.ALL,      # make border all around (implicit top alignment)
                10)          # set border width to 10
        button_sizer.Add(
                wx.Button(self, wx.ID_CANCEL, "Cancel"),
                0,           # make horizontally unstretchable
                wx.ALL,      # make border all around (implicit top alignment)
                10)          # set border width to 10

        topsizer.Add(
                button_sizer,
                0,                # make vertically unstretchable
                wx.ALIGN_CENTER)  # no border and centre horizontally

        self.SetSizerAndFit(topsizer) # use the sizer for layout and size window
                                      # accordingly and prevent it from being resized
                                      # to smaller size

```

--------------------------------

### Autocomplete Example

Source: https://github.com/wxwidgets/phoenix/blob/master/wx/py/CHANGES.txt

Illustrates a scenario where autocomplete list was previously disabled for large lists.

```Python
>>> l = [1, 2, 3]
>>> for n in range(3):
...     l.  <-- failed to popup autocomplete list
```

--------------------------------

### Explore objects in PyShell

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Example of interacting with demo page children and animating a button within a PyShell window.

```python
        >>> b = frame.demoPage.GetChildren()[0]
        >>> for x in range(0, 500, 10):
        ...     b.Move((x, 50))
        ...     app.Yield(True)
        ...     wx.MilliSleep(10)
```

--------------------------------

### Classic wxPython Widget Creation

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/MigrationGuide.rst

Example of the older, more complex method for creating wx.Dialog instances in Classic wxPython, requiring pre-creation and PostCreate calls.

```python
class MyDialog(wx.Dialog):
    def __init__(self, parent, ID, title):
        pre = wx.PreDialog()
        pre.SetExtraStyle(wx.FRAME_EX_CONTEXTHELP)
        pre.Create(parent, ID, title)
        self.PostCreate(pre)                           # 4
```

--------------------------------

### Start Styling Segment

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Initializes the styling process at a specific position with an optional mask to protect style bits.

```cpp
void StartStyling(int pos, int mask);
```

--------------------------------

### Example of Combined Parameter Type and Description

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst

Shows how to combine the parameter type and its description in a single :param: field when the type is a single word.

```rst
:param integer `state`: can be one of: ``wx.CHK_UNCHECKED`` (check
   is off), ``wx.CHK_CHECKED`` (check is on) or
   ``wx.CHK_UNDETERMINED`` (check is mixed).
```

--------------------------------

### Custom wx.DataObjectSimple Implementation

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/MigrationGuide.rst

Example of subclassing wx.DataObjectSimple to handle a custom data format, demonstrating GetDataSize, GetDataHere, and SetData using memoryviews.

```python
class MyDataObject(wx.DataObjectSimple):
    def __init__(self, value=''):
        wx.DataObjectSimple.__init__(self)
        self.SetFormat(wx.DataFormat("my data format"))
        self.myData = bytes(value)

    def GetDataSize(self):
        return len(self.myData)

    def GetDataHere(self, buf):
        # copy our local data value to buf
        assert isinstance(buf, memoryview)
        buf[:] = self.myData
        return True

    def SetData(self, buf):
        # copy from buf to our local data value
        assert isinstance(buf, memoryview)
        self.myData = buf.tobytes()
        return True
```

--------------------------------

### Show Startup Tips with FileProvider

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/tipprovider_overview.rst

Demonstrates how to create and show tips from a text file using wx.adv.CreateFileTipProvider. Ensure 'tips.txt' exists and contains tip text.

```Python
if showTipsAtStartup:

    tipProvider = wx.adv.CreateFileTipProvider("tips.txt", 0)
    wx.adv.ShowTip(windowParent, tipProvider)
    del tipProvider
```

--------------------------------

### WordStartPosition

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Finds the starting position of a word at a given text position. Optionally considers only word characters.

```APIDOC
## WordStartPosition

### Description
Gets the starting position of a word.

### Method
int

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **pos** (int) - The current text position.
* **onlyWordCharacters** (bool) - If true, only considers characters defined as word characters.
```

--------------------------------

### Initialize wxWindow with Size

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Demonstrates equivalent ways to initialize a wxWindow using either a wxSize object or a Python tuple.

```python
win = wxWindow(parent, size = wxSize(100, 100))
win = wxWindow(parent, size = (100, 100))
```

--------------------------------

### Get Selection Range

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the start and end positions of the current text selection. Note the use of output pointers for returning values.

```cpp
**void** GetSelection(**int**\* startPos, **int**\* endPos);
```

--------------------------------

### Example of reST Admonition

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst

Illustrates the use of the .. warning:: directive to create a highlighted block for important notes or warnings.

```rst
.. warning:: I am a warning.
```

--------------------------------

### Initiating Printing and Previewing

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/printing_framework_overview.rst

Demonstrates how to initiate printing or previewing using wx.Printer and wx.PrintPreview. Requires a derived wx.Printout class (e.g., MyPrintout).

```python
if printing:
    printer = wx.Printer()
    printout = MyPrintout("My printout")
    printer.Print(self, printout, True)

elif preview:
    # Pass two printout objects: for preview, and possible printing.
    preview = wx.PrintPreview(MyPrintout(), MyPrintout())
    frame = wx.PreviewFrame(preview, self, "Demo Print Preview",
                            wx.Point(100, 100), wx.Size(600, 650))
    frame.Centre(wx.BOTH)
    frame.Initialize()
    frame.Show(True)
```

--------------------------------

### Initiating a Drag Operation

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/dnd_overview.rst

Start the drag-and-drop process by creating a wx.DropSource object and calling its DoDragDrop method. This method blocks until the drag operation is complete.

```python
dragSource = wx.DropSource(self)
dragSource.SetData(my_data)
result = dragSource.DoDragDrop(True)
```

--------------------------------

### Initialize wxWindow with keyword arguments

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Utilize keyword arguments to specify non-default parameters when initializing wxWindow objects.

```python
win = wxWindow(parent, -1, style = mystyle)
```

--------------------------------

### wx.LEFT Border Flag Example

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

Demonstrates the effect of the wx.LEFT border flag, adding a 20-pixel border to the left side of a control within a sizer.

```python
sizer = wx.BoxSizer(wx.VERTICAL)
# Border size effects
sizer.Add(wx.Button(self, -1, "An extremely long button text"), 0, 0, 0)
sizer.Add(wx.Button(self, -1, "Small Button"), 0, wx.EXPAND | wx.LEFT, 20)
sizer.SetSizeHints(self)
self.SetSizer(sizer)
```

--------------------------------

### Import wx Package

Source: https://github.com/wxwidgets/phoenix/blob/master/wx/py/CHANGES.txt

Demonstrates the modern way to import the wx package.

```Python
import wx
```

--------------------------------

### Upload Extras to extras.wxpython.org

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/HOWTO-Release.rst

Uploads documentation, demos, and pdb archive files to extras.wxpython.org, creating a version-specific directory.

```bash
VERSION={current release version number}
ssh wxpython-extras "mkdir -p wxpython-extras/htdocs/wxPython4/extras/$VERSION"
scp wxPython-[^0-9]* wxpython-extras:wxpython-extras/htdocs/wxPython4/extras/$VERSION
```

--------------------------------

### wx.TOP Border Flag Example

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/sizers_overview.rst

Illustrates the use of the wx.TOP flag to add a border above a control, combined with wx.LEFT and wx.RIGHT for comprehensive side spacing.

```python
sizer = wx.BoxSizer(wx.VERTICAL)
# Border size effects
sizer.Add(wx.Button(self, -1, "An extremely long button text"), 0, 0, 0)
sizer.Add(wx.Button(self, -1, "Small Button"), 0, wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, 20)
sizer.SetSizeHints(self)
self.SetSizer(sizer)
```

--------------------------------

### Create

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Creates the wxStyledTextCtrl window, initializing its appearance and behavior.

```APIDOC
## Create

### Description
Creates the wxStyledTextCtrl window, initializing its appearance and behavior.

### Method
`Create`

### Parameters
* **parent** (wxWindow*) - The parent window.
* **id** (wxWindowID) - The window ID.
* **pos** (const wxPoint&) - The position of the control.
* **size** (const wxSize&) - The size of the control.
* **style** (long) - The window style.
* **name** (const wxString&) - The name of the control.

### Returns
`bool` - Returns true if the creation was successful, false otherwise.
```

--------------------------------

### Buildbot Worker Start Script

Source: https://github.com/wxwidgets/phoenix/blob/master/buildbot/README-bbworker.md

A bash script to start or restart the buildbot worker, ensuring the correct Python environment is sourced.

```bash
#!/bin/bash
source ~/bin/wrangler.sh Py38-bb2
echo "(Re)starting the buildbot-worker"
buildbot-worker restart .
```

--------------------------------

### Create a Cairo Graphics Context

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Demonstrates how to initialize a Cairo renderer and create a graphics context from a device context. Check for None return values to handle cases where Cairo is unsupported or libraries are missing.

```python
cr = wx.GraphicsRenderer.GetCairoRenderer()
ctx = cr.CreateContext(dc)
```

--------------------------------

### SetScrollbar Example

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/scrolling_overview.rst

Configures a vertical scrollbar to display 50 lines of text, with 16 lines visible at a time. The scrollbar position is set to 0 initially.

```python
SetScrollbar(wx.VERTICAL, 0, 16, 50)
```

--------------------------------

### STC Start Drag Event Macro

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Defines an event table entry for the wxEVT_STC_START_DRAG event. Use this macro to bind a function to handle the start of a drag operation within the STC.

```cpp
#define EVT_STC_START_DRAG(id, fn)         DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_START_DRAG,            id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL )
```

--------------------------------

### StartRecord

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Begins recording all key presses and commands.

```APIDOC
## StartRecord

### Description
Initiates the recording of all subsequent key presses and commands. This is typically used for macro recording functionality.

### Method
void

### Endpoint
N/A (SDK Method)

### Parameters
None

### Request Example
N/A

### Response
None
```

--------------------------------

### Run wxWidgets Phoenix Demo

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/README.txt

Execute the demo script using one of the provided commands. Ensure you are in the demo directory.

```bash
demo.py
```

```bash
python demo.py
```

```bash
pythonw demo.py
```

--------------------------------

### STC Dwell Start Event Macro

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Defines an event table entry for the wxEVT_STC_DWELLSTART event. Use this macro to bind a function to handle the start of a dwell event (e.g., mouse hover) in the STC.

```cpp
#define EVT_STC_DWELLSTART(id, fn)         DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLSTART,            id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL )
```

--------------------------------

### GetCaretForeground

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the foreground color of the caret.

```APIDOC
## GetCaretForeground

### Description
Gets the foreground color of the caret.

### Method
GET

### Endpoint
/stc/caret/foreground-color

### Returns
- **wxColour**: The foreground color of the caret.
```

--------------------------------

### Create and Format a wx.grid.Grid

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/grid_overview.rst

Demonstrates how to create a wx.grid.Grid, set its dimensions, customize row and column sizes, set cell values, make cells read-only, apply cell colors, and format columns for floating-point numbers.

```python
import wx
import wx.grid

class GridFrame(wx.Frame):
    def __init__(self, parent):
        wx.Frame.__init__(self, parent)

        # Create a wxGrid object
        grid = wx.grid.Grid(self, -1)

        # Then we call CreateGrid to set the dimensions of the grid
        # (100 rows and 10 columns in this example)
        grid.CreateGrid(100, 10)

        # We can set the sizes of individual rows and columns
        # in pixels
        grid.SetRowSize(0, 60)
        grid.SetColSize(0, 120)

        # And set grid cell contents as strings
        grid.SetCellValue(0, 0, 'wxGrid is good')

        # We can specify that some cells are read.only
        grid.SetCellValue(0, 3, 'This is read.only')
        grid.SetReadOnly(0, 3)

        # Colours can be specified for grid cell contents
        grid.SetCellValue(3, 3, 'green on grey')
        grid.SetCellTextColour(3, 3, wx.GREEN)
        grid.SetCellBackgroundColour(3, 3, wx.LIGHT_GREY)

        # We can specify the some cells will store numeric
        # values rather than strings. Here we set grid column 5
        # to hold floating point values displayed with width of 6
        # and precision of 2
        grid.SetColFormatFloat(5, 6, 2)
        grid.SetCellValue(0, 6, '3.1415')

        self.Show()


if __name__ == '__main__':

    app = wx.App(0)
    frame = GridFrame(None)
    app.MainLoop()
```

--------------------------------

### SetSelectionStart

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Sets the position that starts the selection (the anchor).

```APIDOC
## SetSelectionStart

### Description
Sets the position that starts the selection, which becomes the anchor.

### Method
PUT

### Endpoint
/stc/selection/start

### Parameters
#### Query Parameters
- **pos** (int) - Required - The starting position of the selection.
```

--------------------------------

### Define a Derived wx.App Class

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/app_overview.rst

Illustrates how to create a custom wx.App class by deriving from wx.App and implementing the OnInit method to initialize the application's main window.

```python
class DerivedApp(wx.App):

    def OnInit(self):
        the_frame = wx.Frame(None, -1)

        # Other initialization code...
        the_frame.Show(True)
        return True
```

--------------------------------

### GetSelection

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the start and end positions of the current selection.

```APIDOC
## GetSelection

### Description
Retrieves the start and end positions of the current selection.

### Method
`void GetSelection(int* startPos, int* endPos)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None
```

--------------------------------

### Upload Documentation to docs.wxpython.org

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/HOWTO-Release.rst

Uploads the documentation archive to the docs.wxpython.org server via SCP.

```bash
scp wxPython-docs-*.tar.gz wxpython-docs:wxpython-docs/tmp
```

--------------------------------

### GetLineSelStartPosition

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the start position of the selection on a given line.

```APIDOC
## GetLineSelStartPosition

### Description
Retrieves the position of the start of the selection at the given line. Returns INVALID_POSITION if no selection on this line.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
#### Query Parameters
- **line** (int) - Required - The line number.

### Returns
- **int**: The start position of the selection on the line, or INVALID_POSITION.
```

--------------------------------

### DelLineLeft

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Deletes text from the current position to the start of the line.

```APIDOC
## DelLineLeft

### Description
Deletes back from the current position to the start of the line.

### Method
DELETE (conceptual)

### Endpoint
N/A (SDK method)
```

--------------------------------

### Upload Linux Wheels to extras.wxpython.org

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/HOWTO-Release.rst

Uploads the Linux wheel files to the extras.wxpython.org server.

```bash
scp -r linux wxpython-extras:wxpython-extras/htdocs/wxPython4/extras/
```

--------------------------------

### SetWrapStartIndent

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Sets the indentation level for the start of wrapped lines.

```APIDOC
## SetWrapStartIndent

### Description
Sets the start indent for wrapped lines.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **indent** (int) - The indentation value.
```

--------------------------------

### GetLineEndPosition

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the position after the last visible characters on a line.

```APIDOC
## GetLineEndPosition

### Description
Gets the position after the last visible characters on a line.

### Method
GET

### Endpoint
/stc/lines/{line}/end-position

### Parameters
#### Path Parameters
- **line** (int) - Required - The line number.

### Returns
- **int**: The position after the last visible characters.
```

--------------------------------

### AutoCompGetMaxHeight

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the maximum height of autocompletion and user lists.

```APIDOC
## AutoCompGetMaxHeight

### Description
Gets the maximum height, in rows, of auto-completion and user lists.

### Method
GET

### Endpoint
/stc/autocomp/max-height

### Returns
- **int**: The maximum height in rows.
```

--------------------------------

### Creating and Populating a Format Menu

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/richtextctrl_overview.rst

This snippet demonstrates how to create a wx.Menu object and populate it with various formatting options like bold, italic, underline, alignment, indentation, and font selection. It uses `doBind` to associate menu items with event handlers and update UI handlers.

```Python
formatMenu = wx.Menu()
            doBind( formatMenu.AppendCheckItem(-1, "&Bold\tCtrl+B"),
                    self.OnBold, self.OnUpdateBold)
            doBind( formatMenu.AppendCheckItem(-1, "&Italic\tCtrl+I"),
                    self.OnItalic, self.OnUpdateItalic)
            doBind( formatMenu.AppendCheckItem(-1, "&Underline\tCtrl+U"),
                    self.OnUnderline, self.OnUpdateUnderline)
            formatMenu.AppendSeparator()
            doBind( formatMenu.AppendCheckItem(-1, "L&eft Align"),
                    self.OnAlignLeft, self.OnUpdateAlignLeft)
            doBind( formatMenu.AppendCheckItem(-1, "&Centre"),
                    self.OnAlignCenter, self.OnUpdateAlignCenter)
            doBind( formatMenu.AppendCheckItem(-1, "&Right Align"),
                    self.OnAlignRight, self.OnUpdateAlignRight)
            formatMenu.AppendSeparator()
            doBind( formatMenu.Append(-1, "Indent &More"), self.OnIndentMore)
            doBind( formatMenu.Append(-1, "Indent &Less"), self.OnIndentLess)
            formatMenu.AppendSeparator()
            doBind( formatMenu.Append(-1, "Increase Paragraph &Spacing"), self.OnParagraphSpacingMore)
            doBind( formatMenu.Append(-1, "Decrease &Paragraph Spacing"), self.OnParagraphSpacingLess)
            formatMenu.AppendSeparator()
            doBind( formatMenu.Append(-1, "Normal Line Spacing"), self.OnLineSpacingSingle)
            doBind( formatMenu.Append(-1, "1.5 Line Spacing"), self.OnLineSpacingHalf)
            doBind( formatMenu.Append(-1, "Double Line Spacing"), self.OnLineSpacingDouble)
            formatMenu.AppendSeparator()
            doBind( formatMenu.Append(-1, "&Font..."), self.OnFont)
```

--------------------------------

### AutoCompGetMaxWidth

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the maximum width of autocompletion and user lists.

```APIDOC
## AutoCompGetMaxWidth

### Description
Gets the maximum width, in characters, of auto-completion and user lists.

### Method
GET

### Endpoint
/stc/autocomp/max-width

### Returns
- **int**: The maximum width in characters.
```

--------------------------------

### GetWrapStartIndent

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the current indentation level for the start of wrapped lines.

```APIDOC
## GetWrapStartIndent

### Description
Retrieves the start indent for wrapped lines.

### Method
int

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
* **return value** (int) - The current start indent value.
```

--------------------------------

### AutoCompGetCurrent

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the position of the currently selected item in the auto-completion list.

```APIDOC
## AutoCompGetCurrent

### Description
Retrieves the index of the currently selected item within the auto-completion list.

### Method
int

### Endpoint
N/A (SDK Method)

### Parameters
None

### Request Example
N/A

### Response
*   **Return Value** (int) - The index of the currently selected auto-completion item.
```

--------------------------------

### Menu Bar Creation with Event Binding

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/richtextctrl_overview.rst

Creates a menu bar with file and edit menus, binding menu items to specific handlers and update UI functions. It demonstrates how to bind events for common actions.

```Python
def doBind(item, handler, updateUI=None):

    self.Bind(wx.EVT_MENU, handler, item)
    if updateUI is not None:
        self.Bind(wx.EVT_UPDATE_UI, updateUI, item)

fileMenu = wx.Menu()
doBind( fileMenu.Append(-1, "&Open\tCtrl+O", "Open a file"),
        self.OnFileOpen )
doBind( fileMenu.Append(-1, "&Save\tCtrl+S", "Save a file"),
        self.OnFileSave )
doBind( fileMenu.Append(-1, "&Save As...\tF12", "Save to a new file"),
        self.OnFileSaveAs )
fileMenu.AppendSeparator()
doBind( fileMenu.Append(-1, "&View as HTML", "View HTML"),
        self.OnFileViewHTML)
fileMenu.AppendSeparator()
doBind( fileMenu.Append(-1, "E&xit\tCtrl+Q", "Quit this program"),
        self.OnFileExit )

editMenu = wx.Menu()
doBind( editMenu.Append(wx.ID_UNDO, "&Undo\tCtrl+Z"),
        self.ForwardEvent, self.ForwardEvent)
doBind( editMenu.Append(wx.ID_REDO, "&Redo\tCtrl+Y"),
        self.ForwardEvent, self.ForwardEvent )
editMenu.AppendSeparator()
doBind( editMenu.Append(wx.ID_CUT, "Cu&t\tCtrl+X"),
        self.ForwardEvent, self.ForwardEvent )
doBind( editMenu.Append(wx.ID_COPY, "&Copy\tCtrl+C"),
        self.ForwardEvent, self.ForwardEvent)
doBind( editMenu.Append(wx.ID_PASTE, "&Paste\tCtrl+V"),
        self.ForwardEvent, self.ForwardEvent)
doBind( editMenu.Append(wx.ID_CLEAR, "&Delete\tDel"),
        self.ForwardEvent, self.ForwardEvent)
editMenu.AppendSeparator()
doBind( editMenu.Append(wx.ID_SELECTALL, "Select A&ll\tCtrl+A"),
        self.ForwardEvent, self.ForwardEvent )
```

--------------------------------

### Caret Blink Period

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Functions to get and set the blink period of the caret.

```APIDOC
## Caret Blink Period

### Description
Functions to get and set the blink period of the caret.

### Methods

- **GetCaretPeriod()**: Gets the time in milliseconds that the caret is on and off.
- **SetCaretPeriod(int periodMilliseconds)**: Sets the time in milliseconds that the caret is on and off. A value of 0 means the caret is steady on.
```

--------------------------------

### Get Tab Width

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the current visible width of a tab character.

```cpp
int GetTabWidth();
```

--------------------------------

### TargetFromSelection

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Aligns the target range (start and end) to match the current selection range.

```APIDOC
## TargetFromSelection

### Description
Sets the target range (start and end) to be the same as the current selection range.

### Method
POST

### Endpoint
/stc/targetFromSelection

### Parameters
None

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Using wx.Dialog as a Context Manager

Source: https://github.com/wxwidgets/phoenix/blob/master/CHANGES.rst

Demonstrates the use of the 'with' statement with wx.Dialog to automatically handle dialog destruction.

```python
with MyDialog(self, foo, bar) as dlg:
    if dlg.ShowModal() == wx.ID_OK:
        # do something with dlg values
```

--------------------------------

### Fetch wxWidgets Submodule

Source: https://github.com/wxwidgets/phoenix/blob/master/README.rst

After cloning the Phoenix repository, use these commands to fetch the wxWidgets source code, which is included as a git submodule.

```bash
git submodule update --init --recursive
```

--------------------------------

### Get Anti-Aliasing Setting

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Retrieves the current setting for whether anti-aliased fonts are being used.

```cpp
**bool** GetUseAntiAliasing();
```

--------------------------------

### Combining Window Styles

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/window_styles_overview.rst

Demonstrates how to combine multiple window styles using the bitwise OR operator for window creation.

```Python
style = wx.CAPTION | wx.MINIMIZE_BOX | wx.MAXIMIZE_BOX | wx.RESIZE_BORDER
```

--------------------------------

### PositionAfter

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the document position immediately after the given position, considering code page.

```APIDOC
## PositionAfter

### Description
Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
#### Query Parameters
- **pos** (int) - Required - The starting document position.

### Returns
- **int**: The position after the given position.
```

--------------------------------

### PositionBefore

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the document position immediately before the given position, considering code page.

```APIDOC
## PositionBefore

### Description
Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
#### Query Parameters
- **pos** (int) - Required - The starting document position.

### Returns
- **int**: The position before the given position.
```

--------------------------------

### Initialize RichTextCtrl and Basic Formatting

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/richtextctrl_overview.rst

Demonstrates the initialization of a RichTextCtrl and the application of basic text formatting like bold and centered alignment. It also shows how to suppress undo operations and manage paragraph spacing.

```python
import wx
import wx.richtext as rt
import images

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

class RichTextFrame(wx.Frame):

    def __init__(self, *args, **kw):

        wx.Frame.__init__(self, *args, **kw)

        self.MakeMenuBar()
        self.MakeToolBar()
        self.CreateStatusBar()
        self.SetStatusText("Welcome to wx.richtext.RichTextCtrl!")

        self.rtc = rt.RichTextCtrl(self, style=wx.VSCROLL|wx.HSCROLL|wx.NO_BORDER);
        wx.CallAfter(self.rtc.SetFocus)

        self.rtc.Freeze()
        self.rtc.BeginSuppressUndo()

        self.rtc.BeginParagraphSpacing(0, 20)

        self.rtc.BeginAlignment(rt.TEXT_ALIGNMENT_CENTRE)
        self.rtc.BeginBold()

```

--------------------------------

### GetCodePage

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Gets the code page used to interpret the document's bytes as characters.

```APIDOC
## GetCodePage

### Description
Gets the code page used to interpret the bytes of the document as characters.

### Method
GET

### Endpoint
/stc/codepage

### Returns
- **int**: The code page identifier.
```

--------------------------------

### Header File Format for Help Manuals

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/html_overview.rst

The header file (.hhp) for wx.html help manuals specifies the contents and index files, the book title, and the default topic. Filenames are relative to the .hhp file.

```rst
Contents file=filename.hhc
Index file=filename.hhk
Title=title of your book
Default topic=default page to be displayed.htm
```

--------------------------------

### Build Docker Image and Upload Wheels

Source: https://github.com/wxwidgets/phoenix/blob/master/packaging/HOWTO-Release.rst

Builds wheel files for Linux distributions using Docker and uploads them. Ensure the source tarball is in the Phoenix/dist directory before running.

```bash
python build.py build_docker --release --upload
```

--------------------------------

### Create and Initialize Splitter Window

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/splitterwindow_overview.rst

Create a splitter window with a 3D border and sash. Two subwindows are created, and one is initially hidden. Set a minimum pane size to prevent unsplitting.

```python
splitter = wx.SplitterWindow(self, -1, wx.Point(0, 0),
				     wx.Size(400, 400), wx.SP_3D)

leftWindow = MyWindow(splitter)
leftWindow.SetScrollbars(20, 20, 50, 50)

rightWindow = MyWindow(splitter)
rightWindow.SetScrollbars(20, 20, 50, 50)
rightWindow.Show(False)

splitter.Initialize(leftWindow)

# Set this to prevent unsplitting
# splitter.SetMinimumPaneSize(20)
```

--------------------------------

### Get End of Styled Text Position

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Returns the position of the last character in the document that has been styled.

```cpp
int GetEndStyled();
```

--------------------------------

### Controlling Autocompletion Magic Attribute Inclusion

Source: https://github.com/wxwidgets/phoenix/blob/master/wx/py/CHANGES.txt

Example of how to disable the inclusion of magic attributes in autocompletion.

```python
>>> shell.editor.autoCompleteIncludeMagic = 0
```

--------------------------------

### Setting the Menu Bar

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/richtextctrl_overview.rst

This snippet shows how to create a wx.MenuBar and append existing menus (like the formatMenu, fileMenu, and editMenu) to it. The menu bar is then set for the main window using `self.SetMenuBar`.

```Python
mb = wx.MenuBar()
            mb.Append(fileMenu, "&File")
            mb.Append(editMenu, "&Edit")
            mb.Append(formatMenu, "F&ormat")
            self.SetMenuBar(mb)
```

--------------------------------

### Example of Indented Admonition

Source: https://github.com/wxwidgets/phoenix/blob/master/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst

Demonstrates how to properly indent content within a 'note' admonition in reStructuredText.

```rst
.. note::

   The class :ref:`wx.TreeCtrl` can be used to display a tree, with these notes:

   - The note contains all indented body elements
     following.
   - It includes this bullet list.

```

--------------------------------

### Go To Line

Source: https://github.com/wxwidgets/phoenix/blob/master/demo/data/stc.h.html

Moves the caret to the beginning of the specified line and ensures it is visible on the screen.

```cpp
void GotoLine(int line);
```
Tokens:
Raw