wxWidgets

https://docs.wxwidgets.org/3.2
Admin
wxWidgets is a stable and powerful open-source cross-platform GUI framework for developing native...
Tokens:1,844,236
Snippets:24,743
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup(wxWindow *parent)

Source: https://docs.wxwidgets.org/3.2/classwx_printer.html

Invokes the print setup dialog.

```APIDOC
## bool wxPrinter::Setup(wxWindow *parent)

### Description
Invokes the print setup dialog for the user to configure printer settings.

### Parameters
- **parent** (wxWindow*) - Required - The parent window for the dialog.
```

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

### SetViewer Usage Examples

Source: https://docs.wxwidgets.org/3.2/classwx_help_controller_base.html

Examples of setting the help viewer for wxExtHelpController.

```cpp
m_help.SetViewer("kdehelp");
m_help.SetViewer("gnome-help-browser");
m_help.SetViewer("netscape", wxHELP_NETSCAPE);
```

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

### Install wxWidgets

Source: https://docs.wxwidgets.org/3.2/plat_msw_install.html

Optionally install the library to a global location.

```bash
 $ make install
```

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

### Continue installation process

Source: https://docs.wxwidgets.org/3.2/plat_motif_install.html

Commands to resume the build and installation process after initial configuration.

```bash
> make
> su <type root password>
> make install
> ldconfig
> exit
```

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

### Install static libraries

Source: https://docs.wxwidgets.org/3.2/overview_cmake.html

Configures a static build with a custom installation prefix and executes the install target.

```bash
cmake ~/Downloads/wxWidgets_3.1 \
-DCMAKE_INSTALL_PREFIX=~/wx_install \
-DwxBUILD_SHARED=OFF
cmake --build . --target install
```

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

### wxPrinter::Setup

Source: https://docs.wxwidgets.org/3.2/classwx_printer.html

The Setup method invokes the print setup dialog. Note that this method is deprecated.

```APIDOC
## Setup(wxWindow *parent)

### Description
Invokes the print setup dialog. This method is obsolete and retained only for backward compatibility.

### Parameters
- **parent** (wxWindow*) - The parent window for the setup dialog.

### Returns
- **bool** - Returns true if the dialog was successfully invoked.
```

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

### Build and install wxWidgets with Qt

Source: https://docs.wxwidgets.org/3.2/plat_qt_install.html

Standard sequence of commands to configure, build, and install the library from the base directory.

```bash
> mkdir buildqt
> cd buildqt
> ../configure --with-qt
> make
> su <type root password>
> make install
> ldconfig
```

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

### Install wxWidgets libraries

Source: https://docs.wxwidgets.org/3.2/plat_gtk_install.html

Execute this command with root privileges to install the library and header files after building.

```bash
$ make install
```

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

### Start(const wxString &prefix)

Source: https://docs.wxwidgets.org/3.2/classwx_text_completer-members.html

Pure virtual method to start the completion process with the given prefix.

```APIDOC
## virtual bool Start(const wxString &prefix)

### Description
Starts the completion process for the given prefix. This method must be implemented by subclasses to provide completion results.

### Parameters
- **prefix** (const wxString &) - The prefix string to complete.
```

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

### Install wxWidgets to system directories

Source: https://docs.wxwidgets.org/3.2/plat_osx_install.html

Use sudo to install the library into system directories, requiring administrator privileges.

```bash
sudo make install
type <YOUR OWN PASSWORD>
```

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

### GetLocation Example Usage

Source: https://docs.wxwidgets.org/3.2/classwx_f_s_file.html

Examples of full file locations including paths and protocols.

```text
http://www.wxwidgets.org
http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt
file:/home/vasek/index.htm
relative-file.htm
```

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

### Perform a standard wxWidgets installation

Source: https://docs.wxwidgets.org/3.2/plat_motif_install.html

The basic sequence of commands to configure, build, and install the library on a Linux system.

```bash
> ./configure --with-motif
> make
> su <type root password>
> make install
> ldconfig
> exit
```

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

### Install wxWidgets using vcpkg

Source: https://docs.wxwidgets.org/3.2/plat_msw_install.html

Commands to clone and bootstrap vcpkg, then install wxWidgets for different architectures.

```shell
> git clone https://github.com/Microsoft/vcpkg.git
> cd vcpkg
> bootstrap-vcpkg.bat
> vcpkg integrate install
> vcpkg install wxwidgets
> vcpkg install wxwidgets:x64-windows
```

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

### GetAnchor Example Usage

Source: https://docs.wxwidgets.org/3.2/classwx_f_s_file.html

Examples of how anchors are parsed from file paths.

```text
index.htm#anchor                      // 'anchor' is anchor
index/wx001.htm                       // NO anchor here!
archive/main.zip#zip:index.htm#global // 'global'
archive/main.zip#zip:index.htm        // NO anchor here!
```

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

### Build and install wxWidgets with GTK

Source: https://docs.wxwidgets.org/3.2/plat_gtk_install.html

Standard sequence of commands to configure, build, and install wxWidgets from the source directory.

```bash
$ mkdir buildgtk
$ cd buildgtk
$ ../configure --with-gtk
$ make
$ sudo make install
$ sudo ldconfig
```

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

### Install required dependencies

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2.html

Install essential libraries using pacman before starting the build process.

```bash
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc-libs
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-expat
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-xz
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-zlib
```

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

### wxList<T> Usage Example

Source: https://docs.wxwidgets.org/3.2/classwx_list_3_01_t_01_4.html

Example showing how to declare, define, and iterate over a wxList.

```APIDOC
// Declaration
WX_DECLARE_LIST(MyListElement, MyList);

// Definition
#include <wx/listimpl.cpp>
WX_DEFINE_LIST(MyList);

// Usage
MyList list;
MyListElement element;
list.Append(&element);

// STL-style iteration
for (MyList::iterator iter = list.begin(); iter != list.end(); ++iter) {
    MyListElement *current = *iter;
}

// Legacy-style iteration
MyList::compatibility_iterator node = list.GetFirst();
while (node) {
    MyListElement *current = node->GetData();
    node = node->GetNext();
}
```

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

### Install liblzma using vcpkg

Source: https://docs.wxwidgets.org/3.2/page_build_liblzma.html

Commands to bootstrap vcpkg and install liblzma for Visual Studio projects.

```bash
> git clone https://github.com/Microsoft/vcpkg.git
> cd vcpkg
> .\bootstrap-vcpkg.bat
> .\vcpkg integrate install
> .\vcpkg install liblzma
> .\vcpkg install liblzma:x64-windows
```

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

### Install dependencies via pacman

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2_qt.html

Install required system packages for building wxWidgets on MSYS2.

```bash
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc-libs
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-expat
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-xz
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-zlib
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gdk-pixbuf2
```

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

### Initialize Client and Start Advise Loop

Source: https://docs.wxwidgets.org/3.2/overview_ipc.html

Create a client instance, establish a connection to a server, and initiate an advise loop for data updates.

```cpp
wxString server = "4242";
wxString hostName;
wxGetHostName(hostName);
// Create a new client
MyClient *client = new MyClient;
connection = (MyConnection *)client->MakeConnection(hostName, server, "IPC TEST");
if (!connection)
{
wxMessageBox("Failed to make connection to server", "Client Demo Error");
return NULL;
}
connection->StartAdvise("Item");
```

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

### GetTargetStart

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Gets the position that starts the target.

```APIDOC
## int GetTargetStart()

### Description
Get the position that starts the target.

### Returns
- **int** - The start position.
```

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

### Build and run widgets sample

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2.html

Compile and execute the widgets sample.

```bash
    cd build-${MSYSTEM_CARCH}-msw-static/samples/widgets && make && cd ../../..
    cd samples/widgets && ../../build-${MSYSTEM_CARCH}-msw-static/samples/widgets/widgets.exe && cd ../..
```

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

### View configuration help

Source: https://docs.wxwidgets.org/3.2/plat_qt_install.html

Display all available configuration options for the build process.

```bash
./configure --help
```

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

### Start()

Source: https://docs.wxwidgets.org/3.2/classwx_timer.html

(Re)starts the timer with a specified interval and mode.

```APIDOC
## virtual bool wxTimer::Start(int milliseconds = -1, bool oneShot = wxTIMER_CONTINUOUS)

### Description
Starts or restarts the timer. If the timer was already running, it is stopped before restarting.

### Parameters
- **milliseconds** (int) - Optional - The interval in milliseconds (default is -1, using the previous value).
- **oneShot** (bool) - Optional - If true, the timer triggers only once; if false (default), it runs continuously.

### Returns
- **bool** - Returns false if the timer could not be started, true otherwise.
```

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

### wxShowTip()

Source: https://docs.wxwidgets.org/3.2/group__group__funcmacro__dialog.html

Shows a 'startup tip' to the user and returns the state of the 'Show tips at startup' checkbox.

```APIDOC
## wxShowTip()

### Description
This function shows a 'startup tip' to the user. The return value is the state of the 'Show tips at startup' checkbox.

### Signature
bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = true)

### Parameters
- **parent** (wxWindow*) - The parent window for the modal dialog.
- **tipProvider** (wxTipProvider*) - An object which is used to get the text of the tips.
- **showAtStartup** (bool) - Initial value for 'Show tips at startup' checkbox.

### Include
#include <wx/tipdlg.h>
```

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

### Start()

Source: https://docs.wxwidgets.org/3.2/classwx_stop_watch.html

Starts or restarts the stopwatch with an optional initial value.

```APIDOC
## void Start(long milliseconds = 0)

### Description
(Re)starts the stop watch with a given initial value. The stopwatch will always be running after calling Start(), even if Pause() had been called before.
```

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

### Displaying Startup Tips with wxShowTip

Source: https://docs.wxwidgets.org/3.2/overview_tips.html

Use wxShowTip and wxCreateFileTipProvider to display tips from a text file at application startup.

```cpp
if ( ...show tips at startup?... )
{
wxTipProvider *tipProvider = wxCreateFileTipProvider("tips.txt", 0);
wxShowTip(windowParent, tipProvider);
delete tipProvider;
}
```

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

### Constructing and Configuring wxMenuItem

Source: https://docs.wxwidgets.org/3.2/classwx_menu_item.html

Examples demonstrating how to append stock menu items and customize their properties like help strings and bitmaps.

```cpp
// use all stock properties:
helpMenu->Append(wxID_ABOUT);
// use the stock label and the stock accelerator but not the stock help string:
helpMenu->Append(wxID_ABOUT, "", "My custom help string");
// use all stock properties except for the bitmap:
wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
mymenu->SetBitmap(wxArtProvider::GetBitmap(wxART_WARNING));
helpMenu->Append(mymenu);
```

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

### SetStart(long start)

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_range.html

Sets the start position of the range.

```APIDOC
## void SetStart(long start)

### Description
Sets the start position of the range.

### Parameters
- **start** (long) - The start position to set.
```

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

### Implement Application Initialization

Source: https://docs.wxwidgets.org/3.2/overview_helloworld.html

Override OnInit to create and display the main application window.

```cpp
bool MyApp::OnInit()
{
MyFrame *frame = new MyFrame();
frame->Show(true);
return true;
}
```

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

### StartOnce()

Source: https://docs.wxwidgets.org/3.2/classwx_timer.html

Starts the timer for a single notification.

```APIDOC
## bool wxTimer::StartOnce(int milliseconds = -1)

### Description
Starts the timer for a once-only notification. This is a wrapper for Start() with the wxTIMER_ONE_SHOT parameter.

### Parameters
- **milliseconds** (int) - Optional - The interval in milliseconds (default is -1).
```

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

### Run basic configuration

Source: https://docs.wxwidgets.org/3.2/plat_qt_install.html

Execute the configure script with desired options to prepare the build environment.

```bash
./configure options
```

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

### Build wxWidgets samples and demos

Source: https://docs.wxwidgets.org/3.2/plat_osx_install.html

Commands to navigate to the samples and demos directories and compile them.

```bash
cd samples; make;cd ..
cd demos;   make;cd ..
```

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

### Get

Source: https://docs.wxwidgets.org/3.2/classwx_xml_resource.html

Gets the global resources object or creates one if none exists.

```APIDOC
## static wxXmlResource* Get()

### Description
Gets the global resources object or creates one if none exists.
```

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

### Creating and Configuring a wxGrid

Source: https://docs.wxwidgets.org/3.2/overview_grid.html

Demonstrates how to instantiate a wxGrid, define its size, and apply various cell formatting and data type configurations.

```cpp
// Create a wxGrid object
grid = new wxGrid( this,
-1,
wxPoint( 0, 0 ),
wxSize( 400, 300 ) );
// 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, *wxGREEN);
grid->SetCellBackgroundColour(3, 3, *wxLIGHT_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");
```

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

### SetRange(long start, long end)

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_range.html

Sets both the start and end positions of the range.

```APIDOC
## void SetRange(long start, long end)

### Description
Sets the range start and end positions.

### Parameters
- **start** (long) - The start position.
- **end** (long) - The end position.
```

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

### BeginContextHelp(wxWindow *window)

Source: https://docs.wxwidgets.org/3.2/classwx_context_help-members.html

Starts the context help mode for the specified window.

```APIDOC
## BeginContextHelp(wxWindow *window)

### Description
Starts the context help mode for the specified window.

### Parameters
- **window** (wxWindow*) - Required - The window to start context help for.
```

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

### SetHighlightGuide

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Sets the highlighted indentation guide column. Setting to 0 disables the guide.

```APIDOC
### Method
void SetHighlightGuide(int column)

### Parameters
- **column** (int) - The column index for the indentation guide. 0 disables it.
```

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

### Implement abstract class example

Source: https://docs.wxwidgets.org/3.2/group__group__funcmacro__rtti.html

Example usage of the wxIMPLEMENT_ABSTRACT_CLASS macro in a C++ implementation file.

```cpp
wxIMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject);
wxCommand::wxCommand()
{
...
}
```

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

### Initialize wxDirDialog with Styles

Source: https://docs.wxwidgets.org/3.2/classwx_dir_dialog.html

Example of creating a directory dialog with the recommended default style combined with specific requirements.

```cpp
wxDirDialog dlg(NULL, "Choose input directory", "",
wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST);
```

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

### Disable thread support during installation

Source: https://docs.wxwidgets.org/3.2/plat_motif_install.html

Use these commands to build and install wxWidgets without thread support.

```bash
./configure --disable-threads
make
su <type root password>
make install
ldconfig
exit
```

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

### Using wxMetafile with wxMetafileDC and Clipboard

Source: https://docs.wxwidgets.org/3.2/classwx_metafile.html

Demonstrates creating a metafile using a device context, drawing to it, and passing the resulting metafile to the clipboard.

```cpp
wxMetafileDC dc;
if (dc.IsOk())
{
Draw(dc, false);
wxMetafile *mf = dc.Close();
if (mf)
{
bool success = mf->SetClipboard((int)(dc.MaxX() + 10), (int)(dc.MaxY() + 10));
delete mf;
}
}
```

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

### Initialize(const wxString &dir)

Source: https://docs.wxwidgets.org/3.2/classwx_ext_help_controller.html

Initializes the controller with the directory where documentation is located.

```APIDOC
## Initialize

### Description
This must be called to tell the controller where to find the documentation. If a locale is set, it looks in file/localename first.

### Parameters
- **dir** (const wxString &) - Directory name where to find the help files.

### Returns
- **bool** - true on success.
```

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

### HomeWrap()

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Moves the caret to the start of the display line if word-wrap is enabled, otherwise to the start of the document line.

```APIDOC
## void HomeWrap()

### Description
Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.
```

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

### Manage minimal sample

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2_gtk.html

Commands to clean, build, and execute the minimal sample application.

```bash
 cd build-${MSYSTEM_CARCH}-gtk3-static/samples/minimal && make clean && cd ../../..
```

```bash
 cd build-${MSYSTEM_CARCH}-gtk3-static/samples/minimal && make && cd ../../..
```

```bash
 ./build-${MSYSTEM_CARCH}-gtk3-static/samples/minimal/minimal.exe
```

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

### Configure and build via command line

Source: https://docs.wxwidgets.org/3.2/overview_cmake.html

Standard commands to initialize a build directory and trigger the build process.

```bash
cmake -G "Unix Makefiles" path_to_wxWidgets_root
```

```bash
cmake --build .
```

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

### Initialize

Source: https://docs.wxwidgets.org/3.2/classwx_help_controller.html

Initializes the help instance with a specific help filename.

```APIDOC
## virtual bool Initialize(const wxString &file)

### Description
Initializes the help instance with a help filename.

### Parameters
- **file** (const wxString &) - Required - The filename of the help file to initialize.
```

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

### Initialize and Load XRC Resources

Source: https://docs.wxwidgets.org/3.2/overview_xrc.html

Demonstrates how to initialize resource handlers and load XRC files during application startup.

```cpp
#include "wx/xrc/xmlres.h"
bool MyApp::OnInit()
{
...
wxXmlResource::Get()->InitAllHandlers();
wxXmlResource::Get()->Load("resource.xrc");
wxXmlResource::Get()->LoadAllFiles("rc");
...
}
```

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

### Build a simple application from the command line

Source: https://docs.wxwidgets.org/3.2/overview_install.html

Use wx-config to obtain the necessary compiler and linker flags for a single-source file application on Unix-like systems.

```bash
$ c++ -o hello hello.cpp `wx-config --cxxflags --libs`
```

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

### Create and initialize a wxSplitterWindow

Source: https://docs.wxwidgets.org/3.2/overview_splitterwindow.html

Demonstrates instantiating a splitter window, adding subwindows, and hiding one initially.

```cpp
splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0),
wxSize(400, 400), wxSP_3D);
leftWindow = new MyWindow(splitter);
leftWindow->SetScrollbars(20, 20, 50, 50);
rightWindow = new MyWindow(splitter);
rightWindow->SetScrollbars(20, 20, 50, 50);
rightWindow->Show(false);
splitter->Initialize(leftWindow);
// Set this to prevent unsplitting
// splitter->SetMinimumPaneSize(20);
```

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

### Implement application entry point example

Source: https://docs.wxwidgets.org/3.2/group__group__funcmacro__rtti.html

Example usage of the wxIMPLEMENT_APP macro to define the application entry point.

```cpp
wxIMPLEMENT_APP(MyApp);
```

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

### Install MSys2 build dependencies

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2_gtk.html

Install the necessary development packages for building wxGTK/Win32 via the MSys2 MinGW prompt.

```bash
 pacman -S --needed --noconfirm make
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libjpeg-turbo
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libpng
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libtiff
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-pkg-config
 ## gtk3 can take a long time to update/find fonts
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gtk3
```

```bash
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc-libs
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-expat
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-xz
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-zlib
pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gdk-pixbuf2
```

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

### Install MinGW build dependencies

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2.html

Execute these commands in the MSys2 MinGW prompt to install the required tools and libraries for building wxMSW.

```bash
 pacman -S --needed --noconfirm make
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libjpeg-turbo
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libpng
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libtiff
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc
```

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

### FindItem(long start, wxUIntPtr data)

Source: https://docs.wxwidgets.org/3.2/classwx_list_ctrl.html

Finds an item whose data matches the specified value, starting from the given index.

```APIDOC
## long FindItem(long start, wxUIntPtr data)

### Description
Find an item whose data matches this data, starting from start or the beginning if 'start' is -1.

### Returns
The next matching item if any or -1 (wxNOT_FOUND) otherwise.
```

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

### Configure wxQT with Custom Qt Directory

Source: https://docs.wxwidgets.org/3.2/plat_qt_install.html

Configuring wxWidgets to use a specific Qt installation directory provided by the Qt online installer.

```bash
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=~/Qt/5.11.0/gcc_64
```

```bash
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=c:/Qt/5.11.0/mingw53_32
```

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

### Reading and navigating with wxFileInputStream

Source: https://docs.wxwidgets.org/3.2/overview_stream.html

Demonstrates basic file stream initialization, reading data, error checking, and position management.

```cpp
// The constructor initializes the stream buffer and open the file descriptor
// associated to the name of the file.
wxFileInputStream in_stream("the_file_to_be_read");
// Ok, read some bytes ... nb_datas is expressed in bytes.
in_stream.Read(data, nb_datas);
if (in_stream.LastError() != wxSTREAM_NOERROR) {
// Oh oh, something bad happens.
// For a complete list, look into the documentation at wxStreamBase.
}
// You can also inline all like this.
if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) {
// Do something.
}
// You can also get the last number of bytes REALLY put into the buffer.
size_t really_read = in_stream.LastRead();
// Ok, moves to the beginning of the stream. SeekI returns the last position
// in the stream counted from the beginning.
off_t old_position = in_stream.SeekI(0, wxFromBeginning);
// What is my current position ?
off_t position = in_stream.TellI();
// wxFileInputStream will close the file descriptor on destruction.
```

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

### Install MSys2 MinGW build dependencies

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2_qt.html

Run these commands in the MSys2 MinGW prompt to install the required tools and libraries for building wxQT/Win32.

```bash
 pacman -S --needed --noconfirm make
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libjpeg-turbo
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libpng
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-libtiff
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-gcc
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-pkg-config
 pacman -S --needed --noconfirm ${MINGW_PACKAGE_PREFIX}-qt5
```

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

### Create and populate a wxPropertyGridManager

Source: https://docs.wxwidgets.org/3.2/classwx_property_grid_manager.html

Demonstrates initializing a manager with specific styles and adding properties to multiple pages.

```cpp
wxPropertyGridManager* pgMan = new wxPropertyGridManager(this, PGID,
wxDefaultPosition, wxDefaultSize,
// These and other similar styles are automatically
// passed to the embedded wxPropertyGrid.
wxPG_BOLD_MODIFIED|wxPG_SPLITTER_AUTO_CENTER| 
// Include toolbar.
wxPG_TOOLBAR |
// Include description box.
wxPG_DESCRIPTION |
// Include compactor.
wxPG_COMPACTOR |
// Plus defaults.
wxPGMAN_DEFAULT_STYLE
);
wxPropertyGridPage* page;
page = pgMan->AddPage("First Page");
page->Append( new wxPropertyCategory("Category A1") );
page->Append( new wxIntProperty("Number",wxPG_LABEL,1) );
page->Append( new wxColourProperty("Colour",wxPG_LABEL,*wxWHITE) );
page = pgMan->AddPage("Second Page");
page->Append( "Text",wxPG_LABEL,"(no text)" );
page->Append( new wxFontProperty("Font",wxPG_LABEL) );
// Display a header above the grid
pgMan->ShowHeader();
```

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

### SetInstallPrefix(const wxString &prefix)

Source: https://docs.wxwidgets.org/3.2/classwx_standard_paths.html

Configures the installation prefix for Unix systems. This is useful for portable programs to ensure the correct installation path is identified.

```APIDOC
## void wxStandardPaths::SetInstallPrefix(const wxString &prefix)

### Description
Lets wxStandardPaths know about the real program installation prefix on a Unix system. Portable programs should call this function, typically using the value defined in config.h.

### Parameters
- **prefix** (const wxString &) - Required - The installation prefix path.
```

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

### Create wxEnumProperty with simple choices

Source: https://docs.wxwidgets.org/3.2/overview_propgrid.html

Demonstrates creating a wxEnumProperty using either wxArrayString or a C-style array of strings.

```cpp
//
// Using wxArrayString
//
wxArrayString arrDiet;
arrDiet.Add("Herbivore");
arrDiet.Add("Carnivore");
arrDiet.Add("Omnivore");
pg->Append( new wxEnumProperty("Diet",
wxPG_LABEL,
arrDiet) );
//
// Using wxChar* array
//
const wxChar* arrayDiet[] =
{ wxT("Herbivore"), wxT("Carnivore"), wxT("Omnivore"), NULL };
pg->Append( new wxEnumProperty("Diet",
wxPG_LABEL,
arrayDiet) );
```

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

### FindItem(long start, const wxString &str, bool partial)

Source: https://docs.wxwidgets.org/3.2/classwx_list_ctrl.html

Finds an item whose label matches the specified string, starting from the given index.

```APIDOC
## long FindItem(long start, const wxString &str, bool partial = false)

### Description
Find an item whose label matches this string, starting from start or the beginning if start is -1. The string comparison is case insensitive. If partial is true then this method will look for items which begin with str.

### Returns
The next matching item if any or -1 (wxNOT_FOUND) otherwise.
```

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

### Start(const wxString &prefix)

Source: https://docs.wxwidgets.org/3.2/classwx_text_completer.html

Initializes the iteration process for completions matching the provided prefix.

```APIDOC
## virtual bool Start(const wxString &prefix)

### Description
Called to start iteration over the completions for the given prefix. This method must be implemented by derived classes to prepare the completion data source.

### Parameters
- **prefix** (const wxString &) - Required - The string prefix to find completions for.

### Returns
- **bool** - Returns true if there are completions available for the prefix, false otherwise.
```

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

### XRC Colour Specification Examples

Source: https://docs.wxwidgets.org/3.2/overview_xrcformat.html

Examples of valid colour formats including named colours, hex codes, RGB strings, and system colour constants.

```xml
<fg>red</fg>
<fg>#ff0000</fg>
<fg>rgb(255,0,0)</fg>
<fg>wxSYS_COLOUR_HIGHLIGHT</fg>
```

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

### Build wxQT on Ubuntu

Source: https://docs.wxwidgets.org/3.2/plat_qt_install.html

Standard commands to create a build directory, configure, and compile wxWidgets with Qt support on Ubuntu.

```bash
mkdir bldqt5
cd bldqt5
../configure --with-qt --enable-debug
make
make samples
```

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

### Run()

Source: https://docs.wxwidgets.org/3.2/classwx_event_loop_base.html

Starts the event loop.

```APIDOC
## virtual int Run()

### Description
Starts the event loop and returns the exit code when finished. This method manages the loop execution and idle event generation.
```

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

### Build and run drawing sample

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2.html

Compile and execute the drawing sample.

```bash
    cd build-${MSYSTEM_CARCH}-msw-static/samples/drawing && make && cd ../../..
    cd samples/drawing && ../../build-${MSYSTEM_CARCH}-msw-static/samples/drawing/drawing.exe && cd ../..
```

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

### GetTimestamp

Source: https://docs.wxwidgets.org/3.2/classwx_wizard_event.html

Gets the timestamp for the event.

```APIDOC
## long GetTimestamp()

### Description
Gets the timestamp for the event.
```

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

### Build and run splash sample

Source: https://docs.wxwidgets.org/3.2/plat_msw_msys2.html

Compile and execute the splash sample.

```bash
    cd build-${MSYSTEM_CARCH}-msw-static/samples/splash && make && cd ../../..
    cd samples/splash && ../../build-${MSYSTEM_CARCH}-msw-static/samples/splash/splash.exe && cd ../..
```

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

### GetTitle()

Source: https://docs.wxwidgets.org/3.2/classwx_top_level_window.html

Gets the window title.

```APIDOC
## virtual wxString GetTitle()

### Description
Gets a string containing the window title.
```

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

### Usage of wxMessageBox

Source: https://docs.wxwidgets.org/3.2/group__group__funcmacro__dialog.html

Example demonstrating how to show a message box and handle the user's response.

```cpp
int answer = wxMessageBox("Quit program?", "Confirm",
wxYES_NO | wxCANCEL, main_frame);
if (answer == wxYES)
main_frame->Close();
```

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

### GetVolume()

Source: https://docs.wxwidgets.org/3.2/classwx_media_ctrl.html

Gets the volume of the media.

```APIDOC
## double GetVolume()

### Description
Gets the volume of the media from a 0.0 to 1.0 range.
```

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

### GetWeight

Source: https://docs.wxwidgets.org/3.2/classwx_font.html

Gets the font weight.

```APIDOC
## wxFontWeight GetWeight()

### Description
Gets the font weight. See wxFontWeight for a list of valid weight identifiers.
```

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

### wxModule::OnInit

Source: https://docs.wxwidgets.org/3.2/classwx_module.html

Initializes the module. This method must be implemented by derived classes to perform necessary setup.

```APIDOC
## virtual bool OnInit()

### Description
Provide this function with appropriate initialization for your module. This is called by the application during startup.

### Returns
- **bool** - Returns true if initialization succeeded, false otherwise.
```

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

### GetStyle

Source: https://docs.wxwidgets.org/3.2/classwx_font.html

Gets the font style.

```APIDOC
## wxFontStyle GetStyle()

### Description
Gets the font style. See wxFontStyle for a list of valid styles.
```

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

### Initialize a wxClientDC

Source: https://docs.wxwidgets.org/3.2/overview_dc.html

Create a client device context on the stack by passing the target window as an argument.

```cpp
void MyWindow::OnMyCmd(wxCommandEvent& event)
{
wxClientDC dc(window);
DrawMyPicture(dc);
}
```

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

### Complete Hello World application

Source: https://docs.wxwidgets.org/3.2/overview_helloworld.html

A full implementation of a wxWidgets application including the application class, frame definition, and event handlers.

```cpp
// wxWidgets "Hello World" Program
// For compilers that support precompilation, includes "wx/wx.h".
#include <wx/wxprec.h>
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
class MyApp : public wxApp
{
public:
virtual bool OnInit();
};
class MyFrame : public wxFrame
{
public:
MyFrame();
private:
void OnHello(wxCommandEvent& event);
void OnExit(wxCommandEvent& event);
void OnAbout(wxCommandEvent& event);
};
enum
{
ID_Hello = 1
};
wxIMPLEMENT_APP(MyApp);
bool MyApp::OnInit()
{
MyFrame *frame = new MyFrame();
frame->Show(true);
return true;
}
MyFrame::MyFrame()
: wxFrame(NULL, wxID_ANY, "Hello World")
{
wxMenu *menuFile = new wxMenu;
menuFile->Append(ID_Hello, "&Hello...\tCtrl-H",
"Help string shown in status bar for this menu item");
menuFile->AppendSeparator();
menuFile->Append(wxID_EXIT);
wxMenu *menuHelp = new wxMenu;
menuHelp->Append(wxID_ABOUT);
wxMenuBar *menuBar = new wxMenuBar;
menuBar->Append(menuFile, "&File");
menuBar->Append(menuHelp, "&Help");
SetMenuBar( menuBar );
CreateStatusBar();
SetStatusText("Welcome to wxWidgets!");
Bind(wxEVT_MENU, &MyFrame::OnHello, this, ID_Hello);
Bind(wxEVT_MENU, &MyFrame::OnAbout, this, wxID_ABOUT);
Bind(wxEVT_MENU, &MyFrame::OnExit, this, wxID_EXIT);
}
void MyFrame::OnExit(wxCommandEvent& event)
{
Close(true);
}
void MyFrame::OnAbout(wxCommandEvent& event)
{
wxMessageBox("This is a wxWidgets Hello World example",
"About Hello World", wxOK | wxICON_INFORMATION);
}
void MyFrame::OnHello(wxCommandEvent& event)
{
wxLogMessage("Hello world from wxWidgets!");
}
```

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

### GetFont

Source: https://docs.wxwidgets.org/3.2/classwx_aui_default_dock_art.html

Get a font setting.

```APIDOC
## wxFont wxAuiDefaultDockArt::GetFont(int id)

### Description
Get a font setting.

### Parameters
- **id** (int) - The identifier of the font setting.
```

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

### Initialize and display a wxBannerWindow

Source: https://docs.wxwidgets.org/3.2/classwx_banner_window.html

Demonstrates creating a banner window, setting its text, and adding it to a sizer for layout within a frame.

```cpp
MyFrame::MyFrame(...)
{
... create the frame itself ...
// Create and initialize the banner.
wxBannerWindow* banner = new wxBannerWindow(this, wxTOP);
banner->SetText("Welcome to my wonderful program",
" Before doing anything else, you need to connect to "
"the online server.\n"
" Please enter your credentials in the controls below.");
// And position it along the top edge of the window.
wxSizer* sizer = new wxBoxSizer(wxVERTICAL);
sizer->Add(banner, wxSizerFlags().Expand());
... add the rest of the window contents to the same sizer ...
SetSizerAndFit(sizer);
}
```

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

### GetInstallPrefix()

Source: https://docs.wxwidgets.org/3.2/classwx_standard_paths.html

Retrieves the program installation prefix.

```APIDOC
## wxStandardPaths::GetInstallPrefix()

### Description
Returns the program installation prefix (e.g., /usr, /opt). If not set via SetInstallPrefix(), it attempts to determine it automatically on Unix platforms.

### Signature
`wxString GetInstallPrefix() const`

### Availability
Unix platforms (wxGTK port).
```

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

### bool wxConnection::StartAdvise(const wxString &item)

Source: https://docs.wxwidgets.org/3.2/classwx_connection.html

Requests the server to start an advise loop for the specified item.

```APIDOC
## bool wxConnection::StartAdvise(const wxString &item)

### Description
Called by the client application to ask if an advise loop can be started with the server. This triggers the server connection's OnStartAdvise() member.

### Parameters
- **item** (const wxString &) - Required - The item to start the advise loop for.

### Returns
- **bool** - Returns true if the server accepts the request, false otherwise.
```

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

### WordStartPosition

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Retrieves the starting position of a word.

```APIDOC
## int wxStyledTextCtrl::WordStartPosition(int pos, bool onlyWordCharacters)

### Description
Get position of start of word.
```

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

### Init()

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_context_menu_properties_info.html

Initializes the wxRichTextContextMenuPropertiesInfo instance.

```APIDOC
## void Init()

### Description
Performs initialization of the object.
```

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

### StartStyling

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Sets the starting position for styling.

```APIDOC
## void StartStyling(int start)

### Description
Set the current styling position to start.

### Parameters
- **start** (int) - The starting position for styling.
```

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

### SetTargetStart

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Sets the position that starts the target.

```APIDOC
## void SetTargetStart(int start)

### Description
Sets the position that starts the target which is used for updating the document without affecting the scroll position.

### Parameters
- **start** (int) - The starting position.
```

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

### wxInitialize

Source: https://docs.wxwidgets.org/3.2/group__group__funcmacro__appinitterm.html

Initializes the wxWidgets library.

```APIDOC
## bool wxInitialize(int argc = 0, wxChar **argv = NULL)

### Description
Initializes the library. Each call to wxInitialize() must be matched by a call to wxUninitialize().
```

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

### Build minimal sample

Source: https://docs.wxwidgets.org/3.2/plat_msw_install.html

Compile the minimal sample to verify the library build.

```bash
 $ cd samples/minimal
 $ make
```

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

### GetSelectionStart

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Returns the position at the start of the selection.

```APIDOC
## int GetSelectionStart() const

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

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

### GetSelectionNStart

Source: https://docs.wxwidgets.org/3.2/classwx_styled_text_ctrl.html

Returns the position at the start of the selection.

```APIDOC
## int GetSelectionNStart(int selection) const

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

### Parameters
- **selection** (int) - The index of the selection.
```

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

### Implementing a Custom Bitmap Bundle

Source: https://docs.wxwidgets.org/3.2/classwx_bitmap_bundle_impl.html

Example showing how to derive from wxBitmapBundleImpl and register the implementation using wxBitmapBundle::FromImpl.

```cpp
class MyCustomBitmapBundleImpl : public wxBitmapBundleImpl
{
public:
MyCustomBitmapBundleImpl()
{
}
wxSize GetDefaultSize() const wxOVERRIDE
{
... determine the minimum/default size for bitmap to use ...
}
wxSize GetPreferredBitmapSizeAtScale(double scale) const wxOVERRIDE
{
// If it's ok to scale the bitmap, just use the standard size
// at the given scale:
return GetDefaultSize()*scale;
... otherwise, an existing bitmap of the size closest to the
one above would need to be found and its size returned,
possibly by letting DoGetPreferredSize() choose it ...
}
wxBitmap GetBitmap(const wxSize& size) wxOVERRIDE
{
... get the bitmap of the requested size from somewhere and
cache it if necessary, i.e. if getting it is expensive ...
}
};
toolBar->AddTool(wxID_OPEN, wxBitmapBundle::FromImpl(new MyCustomBitmapBundleImpl());
```

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

### Initialize wxContextHelp

Source: https://docs.wxwidgets.org/3.2/classwx_context_help.html

Constructs a context help object to initiate context-sensitive help mode for a specified window.

```cpp
wxContextHelp contextHelp(myWindow);
```

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

### wxThread::Run

Source: https://docs.wxwidgets.org/3.2/classwx_thread.html

Starts the thread execution.

```APIDOC
## wxThreadError wxThread::Run()

### Description
Starts the execution of the thread.
```

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

### wxModule::OnInit

Source: https://docs.wxwidgets.org/3.2/classwx_module.html

Initializes the module. This method must be overridden in derived classes to perform necessary setup.

```APIDOC
## virtual bool OnInit()

### Description
Override this function to provide initialization logic for your module. Return true to indicate successful initialization.

### Returns
- **bool** - true if initialization succeeded, false otherwise.
```

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

### wxTimerRunner::Start

Source: https://docs.wxwidgets.org/3.2/classwx_timer_runner.html

Starts the managed timer.

```APIDOC
## void Start(int milli, bool oneShot=false)

### Description
Starts the timer associated with this runner.

### Parameters
- **milli** (int) - The time in milliseconds.
- **oneShot** (bool) - Whether the timer should trigger only once (default: false).
```

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

### StartAdvise()

Source: https://docs.wxwidgets.org/3.2/classwx_t_c_p_connection.html

Initiates an advise loop with the server.

```APIDOC
## virtual bool wxTCPConnection::StartAdvise(const wxString &item)

### Description
Called by the client application to ask if an advise loop can be started with the server. This causes the server connection's OnStartAdvise() member to be called.

### Returns
bool - Returns true if the server accepts the request, false otherwise.
```

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

### Build the minimal sample

Source: https://docs.wxwidgets.org/3.2/overview_cmake.html

Configures the project to include samples and builds only the minimal target.

```bash
cmake ~/Downloads/wxWidgets_3.1 -DwxBUILD_SAMPLES=SOME
cmake --build . --target minimal
```

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

### StartCellSelection

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_ctrl.html

Starts selecting table cells.

```APIDOC
## bool StartCellSelection(wxRichTextTable *table, wxRichTextParagraphLayoutBox *newCell)

### Description
Starts selecting table cells.

### Parameters
- **table** (wxRichTextTable*) - The table containing the cell.
- **newCell** (wxRichTextParagraphLayoutBox*) - The cell to start selection from.
```

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

### MoveHome

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_ctrl.html

Moves the caret to the start of the buffer.

```APIDOC
### virtual bool MoveHome(int flags = 0)

Moves the caret to the start of the buffer.
```

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

### Build wxWidgets samples with nmake

Source: https://docs.wxwidgets.org/3.2/plat_msw_binaries.html

Use this command to build samples from the command line when using makefile.vc files.

```shell
> nmake /f makefile.vc BUILD=release SHARED=1 COMPILER_PREFIX=vc14x
```

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

### wxStopWatch::Start

Source: https://docs.wxwidgets.org/3.2/classwx_stop_watch.html

Starts or restarts the stopwatch.

```APIDOC
## void Start(long milliseconds = 0)

### Description
(Re)starts the stop watch with a given initial value.
```

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

### Create

Source: https://docs.wxwidgets.org/3.2/classwx_aui_tool_bar.html

Initializes the toolbar window.

```APIDOC
## wxAuiToolBar::Create

### Description
Creates the toolbar window if it was initialized using the default constructor.

### Parameters
- **parent** (wxWindow*) - The parent window.
- **id** (wxWindowID) - The window ID.
- **pos** (const wxPoint&) - The position.
- **size** (const wxSize&) - The size.
- **style** (long) - The toolbar style.
```

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

### GetStart()

Source: https://docs.wxwidgets.org/3.2/classwx_rich_text_range.html

Returns the start position of the range.

```APIDOC
## long GetStart()

Returns the start position of the range.
```

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

### Two-step window initialization pattern

Source: https://docs.wxwidgets.org/3.2/classwx_window.html

Demonstrates using the default constructor followed by Create() to defer window visibility until initialization is complete.

```cpp
wxPanel* panel = new wxPanel(); // Note: default constructor used.
panel->Hide(); // Can be called before actually creating it.
panel->Create(parent, wxID_ANY, ...); // Won't be shown yet.
... create all the panel children ...
panel->Show(); // Now everything will be shown at once.
```

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

### Create

Source: https://docs.wxwidgets.org/3.2/classwx_simplebook-members.html

Initializes the wxSimplebook control with the specified parent, ID, position, size, style, and name.

```APIDOC
## Create

### Description
Initializes the wxSimplebook control.

### Signature
`bool Create(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxEmptyString)`
```

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

### OnBeginPrinting

Source: https://docs.wxwidgets.org/3.2/classwx_printout.html

Called by the framework at the start of printing.

```APIDOC
## virtual void OnBeginPrinting()

### Description
Called by the framework at the start of printing. This method is called once for every print job, regardless of the number of copies being printed.
```

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

### Opening a file with wxFileDialog

Source: https://docs.wxwidgets.org/3.2/classwx_file_dialog.html

Demonstrates the typical workflow for opening a file, including user confirmation and stream-based file loading.

```cpp
void MyFrame::OnOpen(wxCommandEvent& WXUNUSED(event))
{
if (...current content has not been saved...)
{
if (wxMessageBox(_("Current content has not been saved! Proceed?"), _("Please confirm"),
wxICON_QUESTION | wxYES_NO, this) == wxNO )
return;
//else: proceed asking to the user the new file to open
}
wxFileDialog
openFileDialog(this, _("Open XYZ file"), "", "",
"XYZ files (*.xyz)|*.xyz", wxFD_OPEN|wxFD_FILE_MUST_EXIST);
if (openFileDialog.ShowModal() == wxID_CANCEL)
return; // the user changed idea...
// proceed loading the file chosen by the user;
// this can be done with e.g. wxWidgets input streams:
wxFileInputStream input_stream(openFileDialog.GetPath());
if (!input_stream.IsOk())
{
wxLogError("Cannot open file '%s'.", openFileDialog.GetPath());
return;
}
...
}
```

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

### StartPage

Source: https://docs.wxwidgets.org/3.2/classwx_printer_d_c.html

Starts a new page in the document.

```APIDOC
## void StartPage()

### Description
Starts a document page. This method is only relevant when outputting to a printer.
```

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

### Define a wxWidgets application

Source: https://docs.wxwidgets.org/3.2/overview_app.html

Example of deriving from wxApp and implementing the OnInit method to initialize the application.

```cpp
class DerivedApp : public wxApp
{
public:
virtual bool OnInit();
};
wxIMPLEMENT_APP(DerivedApp);
bool DerivedApp::OnInit()
{
wxFrame *the_frame = new wxFrame(NULL, ID_MYFRAME, argv[0]);
...
the_frame->Show(true);
return true;
}
```

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

### begin()

Source: https://docs.wxwidgets.org/3.2/classwx_list_3_01_t_01_4.html

Returns an iterator to the start of the list.

```APIDOC
## begin()

### Description
Returns an iterator pointing to the beginning of the list. Overloads exist for const and non-const access.

### Signatures
`iterator begin()`
`const_iterator begin() const`
```

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

### GetStartColour()

Source: https://docs.wxwidgets.org/3.2/classwx_graphics_gradient_stops.html

Returns the start colour of the gradient.

```APIDOC
## wxColour GetStartColour() const

### Description
Returns the start colour defined for the gradient.
```

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

### Initiate Printing and Previewing with wxPrintout

Source: https://docs.wxwidgets.org/3.2/overview_printing.html

Demonstrates how to trigger the print dialog and the print preview frame using a custom MyPrintout class.

```cpp
case WXPRINT_PRINT:
{
wxPrinter printer;
MyPrintout printout("My printout");
printer.Print(this, &printout, true);
break;
}
case WXPRINT_PREVIEW:
{
// Pass two printout objects: for preview, and possible printing.
wxPrintPreview *preview = new wxPrintPreview(new MyPrintout, new MyPrintout);
wxPreviewFrame *frame = new wxPreviewFrame(preview, this,
"Demo Print Preview");
frame->Initialize();
frame->Centre(wxBOTH);
frame->Show(true);
break;
}
```

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

### Enable a window before creation

Source: https://docs.wxwidgets.org/3.2/classwx_window.html

Demonstrates how to initialize a window in a disabled state by calling Enable before Create.

```cpp
wxWindow* w = new MyWindow(); // Note: default ctor is used here.
w->Enable(false);
w->Create(parent, ... all the usual non-default ctor arguments ...); 
```

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

### BeginDrag

Source: https://docs.wxwidgets.org/3.2/classwx_drag_image.html

Starts the drag operation for the image.

```APIDOC
## bool BeginDrag(const wxPoint &hotspot, wxWindow *window, bool fullScreen=false, wxRect *rect=NULL)
## bool BeginDrag(const wxPoint &hotspot, wxWindow *window, wxWindow *boundingWindow)

### Description
Starts dragging the image, either within a specific window or across the full screen.
```

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

### Downloading a file with wxFTP

Source: https://docs.wxwidgets.org/3.2/classwx_f_t_p.html

Demonstrates connecting to an FTP server, changing directories, and reading file content into a buffer using an input stream.

```cpp
wxFTP ftp;
// if you don't use these lines anonymous login will be used
ftp.SetUser("user");
ftp.SetPassword("password");
if ( !ftp.Connect("ftp.wxwidgets.org") )
{
wxLogError("Couldn't connect");
return;
}
ftp.ChDir("/pub/2.8.9");
const char *filename = "wxWidgets-2.8.9.tar.bz2";
int size = ftp.GetFileSize(filename);
if ( size == -1 )
{
wxLogError("Couldn't get the file size for \"%s\"", filename);
}
wxInputStream *in = ftp.GetInputStream(filename);
if ( !in )
{
wxLogError("Couldn't get the file");
}
else
{
char *data = new char[size];
if ( !in->Read(data, size) )
{
wxLogError("Read error: %d", ftp.GetError());
}
else
{
// file data is in the buffer
...
}
delete [] data;
delete in;
}
// gracefully close the connection to the server
ftp.Close();
```

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

### SetInitialDirectory

Source: https://docs.wxwidgets.org/3.2/classwx_dir_picker_ctrl.html

Sets the starting directory for the browser.

```APIDOC
## void SetInitialDirectory(const wxString &dir)

### Description
Set the directory to show when starting to browse for directories.
```
Tokens:
Raw