OpenCPN Partial API docs
Loading...
Searching...
No Matches
gui_lib.cpp File Reference

Implements gui_lib.h. More...

#include <wx/artprov.h>
#include <wx/dialog.h>
#include <wx/sizer.h>
#include <wx/statbmp.h>
#include "gui_lib.h"
#include "timers.h"
#include "FontMgr.h"
#include "OCPNPlatform.h"
#include "ocpn_plugin.h"
#include "displays.h"

Go to the source code of this file.

Functions

wxFont * GetOCPNScaledFont (wxString item, int default_size)
 Retrieves a font from FontMgr, optionally scaled for physical readability.
 
wxFont GetOCPNGUIScaledFont (wxString item)
 Retrieves a font optimized for touch and high-resolution interfaces.
 
int OCPNMessageBox (wxWindow *parent, const wxString &message, const wxString &caption, int style, int timeout_sec, int x, int y)
 

Variables

bool g_bresponsive
 Flag to control adaptive UI scaling.
 
OCPNPlatformg_Platform
 
int g_GUIScaleFactor
 

Detailed Description

Implements gui_lib.h.

Definition in file gui_lib.cpp.

Function Documentation

◆ GetOCPNGUIScaledFont()

wxFont GetOCPNGUIScaledFont ( wxString  item)

Retrieves a font optimized for touch and high-resolution interfaces.

Generates a font specifically tuned for responsive and touch-friendly interfaces, with more aggressive scaling than standard font methods.

Parameters
itemUI element identifier (e.g., "AISTargetAlert", "StatusBar")
Returns
A wxFont object scaled for touch and high-resolution interfaces
Note
Ensures minimum physical font size for improved readability
Particularly suitable for toolbars, buttons, and touch controls

Definition at line 83 of file gui_lib.cpp.

◆ GetOCPNScaledFont()

wxFont * GetOCPNScaledFont ( wxString  item,
int  default_size = 0 
)

Retrieves a font from FontMgr, optionally scaled for physical readability.

Returns a font configured for a specific UI context, scaling based on system settings and preserving readability across different displays.

Parameters
itemUI element identifier (e.g., "AISTargetAlert", "StatusBar")
default_sizeOptional base font size in points. 0 uses platform default.
Returns
Pointer to a dynamically scaled wxFont
Note
Font is managed by OpenCPN's central font cache
Pointer is shared and should not be deleted by caller

Definition at line 54 of file gui_lib.cpp.

◆ OCPNMessageBox()

int OCPNMessageBox ( wxWindow *  parent,
const wxString &  message,
const wxString &  caption,
int  style,
int  timeout_sec,
int  x,
int  y 
)

Definition at line 110 of file gui_lib.cpp.

Variable Documentation

◆ g_bresponsive

bool g_bresponsive
extern

Flag to control adaptive UI scaling.

When true, OpenCPN will automatically maximize the application window if the pixel density suggests a touch-friendly device.

This helps ensure better usability on mobile and tablet devices by providing a full-screen interface optimized for touch interaction.

Note
For the most part, the use of this feature is conditionally compiled for Android builds only.

Definition at line 666 of file ocpn_app.cpp.

◆ g_GUIScaleFactor

int g_GUIScaleFactor
extern

Definition at line 403 of file ocpn_app.cpp.

◆ g_Platform

OCPNPlatform* g_Platform
extern

Definition at line 254 of file ocpn_app.cpp.