- Generated by
1.16.1
|
Mach Modules Documentation
Lua Module API Documentation
|
Go to the source code of this file.
Functions | |
| Formatting | CreateFont (point_size, bold, italics, underlined) |
| Create a wx font using the MachMotion standard font family. | |
| Formatting | ConvertFontStringToFontObject (font_string) |
| Convert a native font info descriptor string to a wx font object. | |
| Formatting | ConvertFontObjectToFontString (font_object) |
| Convert a wx font object to its native font info descriptor string. | |
| Formatting | IsFontWeight (font_object, weight) |
| Check whether a wx font object has a specific font weight. | |
| Formatting | IsFontWeightBold (font_object) |
| Check whether a wx font object has a bold-class font weight. | |
| Formatting | IsFontName (font_object, name) |
| Check whether a wx font object has a specific face name. | |
| Formatting | GetFontName (font_object) |
| Get the face name of a wx font object. | |
| Formatting | SetFontName (font_object, name) |
| Set the face name of a wx font object. | |
| Formatting | GetFontFamily (font_object) |
| Get the font family of a wx font object. | |
| Formatting | SetFontFamily (font_object, name) |
| Set the font family of a wx font object. | |
| Formatting | IsApprovedScreenFont (font_object) |
| Check whether a font object uses an approved MachMotion screen font face name. | |
| Formatting | IsApprovedFont (wxfont) |
| Check whether a wx font object uses an approved MachMotion font face name. | |
| Formatting | CreateCodeBlocksFont (point_size, bold, italics, underlined) |
| Create a wxFont using the CodeBlocks monospace font family. | |
| Formatting | GetDefault () |
| Get the default color sentinel value indicating no color override. | |
| Formatting | GetPink () |
| Get the color pink. | |
| Formatting | GetPurple () |
| Get the color purple. | |
| Formatting | GetLightBlue () |
| Get the color light blue. | |
| Formatting | GetBrightBlue () |
| Get the color bright blue. | |
| Formatting | GetNeonBlue () |
| Get the color neon blue. | |
| Formatting | GetBlue () |
| Get the color blue. | |
| Formatting | GetLightGreen () |
| Get the color light green. | |
| Formatting | GetGreen () |
| Get the color green. | |
| Formatting | GetDarkGreen () |
| Get the color dark green. | |
| Formatting | GetPaleYellow () |
| Get the color pale yellow. | |
| Formatting | GetYellow () |
| Get the color yellow. | |
| Formatting | GetOrange () |
| Get the MachMotion standard orange color. | |
| Formatting | GetBrown () |
| Get the color brown. | |
| Formatting | GetRed () |
| Get the color red. | |
| Formatting | GetDarkRed () |
| Get the color dark red. | |
| Formatting | GetGrey () |
| Get the color grey. | |
| Formatting | GetOffWhite () |
| Get the color off-white. | |
| Formatting | GetWhite () |
| Get the color white. | |
| Formatting | GetBlack () |
| Get the color black. | |
| Formatting | GetMachMotionGrey () |
| Get the MachMotion standard grey UI color. | |
| Formatting | GetMMDROReadFG () |
| Get the DRO read foreground color from the active color scheme. | |
| Formatting | GetMMDROReadBG () |
| Get the DRO read background color from the active color scheme. | |
| Formatting | GetMMDROWriteFG () |
| Get the DRO write foreground color from the active color scheme. | |
| Formatting | GetMMDROWriteBG () |
| Get the DRO write background color from the active color scheme. | |
| Formatting | GetMMDROWriteEditdorBG () |
| Get the DRO write editor background color from the active color scheme. | |
| Formatting | GetMMMachineCordFG () |
| Get the machine coordinates DRO foreground color from the active color scheme. | |
| Formatting | GetMMMachineCordBG () |
| Get the machine coordinates DRO background color from the active color scheme. | |
| Formatting | PartCordFG () |
| Get the part coordinates DRO foreground color from the active color scheme. | |
| Formatting | PartCordBG () |
| Get the part coordinates DRO background color from the active color scheme. | |
| Formatting ConvertFontObjectToFontString | ( | font_object | ) |
Convert a wx font object to its native font info descriptor string.
| font_object | (userdata) The wx.wxFont object to convert |
| Formatting ConvertFontStringToFontObject | ( | font_string | ) |
Convert a native font info descriptor string to a wx font object.
Creates a default wx.wxFont and applies the native font info string via SetNativeFontInfo() to reconstruct the font described by the string.
| font_string | (string) A native font info descriptor string as returned by GetNativeFontInfoDesc() |
| Formatting CreateCodeBlocksFont | ( | point_size | , |
| bold | , | ||
| italics | , | ||
| underlined | ) |
Create a wxFont using the CodeBlocks monospace font family.
Creates a wx.wxFont using Formatting.CodeBlocksFontName ("Courier New") with the specified style options. Unlike CreateFont(), bold maps to wxFONTWEIGHT_BOLD (not SemiBold). If point_size is nil, defaults to Formatting.FontSizeStandard. If underlined is nil or not a boolean, defaults to false.
| point_size | (number|nil) The font point size. Defaults to Formatting.FontSizeStandard if nil |
| bold | (boolean|nil) If true, uses wxFONTWEIGHT_BOLD; otherwise wxFONTWEIGHT_NORMAL |
| italics | (boolean|nil) If true, uses wxFONTSTYLE_ITALIC; otherwise wxFONTSTYLE_NORMAL |
| underlined | (boolean|nil) If true, the font is underlined. Defaults to false if nil or non-boolean |
| Formatting CreateFont | ( | point_size | , |
| bold | , | ||
| italics | , | ||
| underlined | ) |
Create a wx font using the MachMotion standard font family.
Creates a wx.wxFont using Formatting.FontName ("Roboto SemiCondensed") with the specified style options. Bold maps to wxFONTWEIGHT_SEMIBOLD. If point_size is nil, defaults to Formatting.FontSizeStandard. If underlined is nil or not a boolean, defaults to false. Includes a workaround for a ZeroBrane Studio issue where weight may be nil.
| point_size | (number|nil) The font point size. Defaults to Formatting.FontSizeStandard if nil |
| bold | (boolean|nil) If true, uses wxFONTWEIGHT_SEMIBOLD; otherwise wxFONTWEIGHT_NORMAL |
| italics | (boolean|nil) If true, uses wxFONTSTYLE_ITALIC; otherwise wxFONTSTYLE_NORMAL |
| underlined | (boolean|nil) If true, the font is underlined. Defaults to false if nil or non-boolean |
| Formatting GetBlack | ( | ) |
Get the color black.
| Formatting GetBlue | ( | ) |
Get the color blue.
| Formatting GetBrightBlue | ( | ) |
Get the color bright blue.
| Formatting GetBrown | ( | ) |
Get the color brown.
| Formatting GetDarkGreen | ( | ) |
Get the color dark green.
| Formatting GetDarkRed | ( | ) |
Get the color dark red.
| Formatting GetDefault | ( | ) |
Get the default color sentinel value indicating no color override.
Returns a wx.wxColour constructed with (-1, -1, -1), which wxWidgets interprets as the system default color. Use this to reset a control's color to its default appearance.
| Formatting GetFontFamily | ( | font_object | ) |
Get the font family of a wx font object.
| font_object | (userdata) The wx.wxFont object to query |
| Formatting GetFontName | ( | font_object | ) |
Get the face name of a wx font object.
| font_object | (userdata) The wx.wxFont object to query |
| Formatting GetGreen | ( | ) |
Get the color green.
| Formatting GetGrey | ( | ) |
Get the color grey.
| Formatting GetLightBlue | ( | ) |
Get the color light blue.
| Formatting GetLightGreen | ( | ) |
Get the color light green.
| Formatting GetMachMotionGrey | ( | ) |
Get the MachMotion standard grey UI color.
| Formatting GetMMDROReadBG | ( | ) |
Get the DRO read background color from the active color scheme.
| Formatting GetMMDROReadFG | ( | ) |
Get the DRO read foreground color from the active color scheme.
| Formatting GetMMDROWriteBG | ( | ) |
Get the DRO write background color from the active color scheme.
| Formatting GetMMDROWriteEditdorBG | ( | ) |
Get the DRO write editor background color from the active color scheme.
| Formatting GetMMDROWriteFG | ( | ) |
Get the DRO write foreground color from the active color scheme.
| Formatting GetMMMachineCordBG | ( | ) |
Get the machine coordinates DRO background color from the active color scheme.
| Formatting GetMMMachineCordFG | ( | ) |
Get the machine coordinates DRO foreground color from the active color scheme.
| Formatting GetNeonBlue | ( | ) |
Get the color neon blue.
| Formatting GetOffWhite | ( | ) |
Get the color off-white.
| Formatting GetOrange | ( | ) |
Get the MachMotion standard orange color.
| Formatting GetPaleYellow | ( | ) |
Get the color pale yellow.
| Formatting GetPink | ( | ) |
Get the color pink.
| Formatting GetPurple | ( | ) |
Get the color purple.
| Formatting GetRed | ( | ) |
Get the color red.
| Formatting GetWhite | ( | ) |
Get the color white.
| Formatting GetYellow | ( | ) |
Get the color yellow.
| Formatting IsApprovedFont | ( | wxfont | ) |
Check whether a wx font object uses an approved MachMotion font face name.
| wxfont | (userdata) The wx.wxFont object to check |
| Formatting IsApprovedScreenFont | ( | font_object | ) |
Check whether a font object uses an approved MachMotion screen font face name.
| font_object | (userdata) The wx.wxFont object to check |
| Formatting IsFontName | ( | font_object | , |
| name | ) |
Check whether a wx font object has a specific face name.
| font_object | (userdata) The wx.wxFont object to check |
| name | (string) The font face name to compare against |
References name().
| Formatting IsFontWeight | ( | font_object | , |
| weight | ) |
Check whether a wx font object has a specific font weight.
| font_object | (userdata) The wx.wxFont object to check |
| weight | (number) The wx font weight constant to compare against (e.g., wx.wxFONTWEIGHT_BOLD) |
| Formatting IsFontWeightBold | ( | font_object | ) |
Check whether a wx font object has a bold-class font weight.
Returns true if the font weight is any of SemiBold, Bold, or ExtraBold as defined by Formatting.FontWeightSemiBold, Formatting.FontWeightBold, and Formatting.FontWeightExtraBold.
| font_object | (userdata) The wx.wxFont object to check |
| Formatting PartCordBG | ( | ) |
Get the part coordinates DRO background color from the active color scheme.
| Formatting PartCordFG | ( | ) |
Get the part coordinates DRO foreground color from the active color scheme.
| Formatting SetFontFamily | ( | font_object | , |
| name | ) |
Set the font family of a wx font object.
| font_object | (userdata) The wx.wxFont object to modify |
| name | (number) The wx font family constant (e.g., wx.wxFONTFAMILY_DEFAULT) |
References name().
| Formatting SetFontName | ( | font_object | , |
| name | ) |
Set the face name of a wx font object.
| font_object | (userdata) The wx.wxFont object to modify |
| name | (string) The font face name to apply (e.g., "Roboto SemiCondensed") |
References name().
1.16.1