wxPreviewControlBar(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💖 wxPreviewControlBar 💖

okay so bestie, this is the Erlang module definition for wxPreviewControlBar from the wx crew — it's a whole module, and we're gonna walk it together like it's a group project we both actually care about. 🫶

✨ NAME ✨

wxPreviewControlBar — this is the default implementation of the preview control bar, which is literally just a panel with buttons and a zoom control. that's the whole vibe. 💅

🌸 DESCRIPTION 🌸

So here's the tea: you can derive a new class from this and override some or all of the member functions if you wanna change how it behaves and how it looks. or… you can just leave it exactly as it is, because it already ate. your call, no pressure. 💖

See also, bestie:

  • wxPreviewFrame
  • wxPreviewCanvas
  • wxPrintPreview

And just so you know your family tree: this class is derived from — and can use functions from — these icons:

  • wxPanel
  • wxWindow
  • wxEvtHandler

wxWidgets docs: wxPreviewControlBar

🦋 DATA TYPES 🦋

wxPreviewControlBar() :: wx:wx_object().

okay it's just an wx_object(). simple. gorgeous. iconic. ✨

🎀 FUNCTIONS 🎀

  • createButtons(This) -> ok when This :: wxPreviewControlBar().

Creates buttons, according to the value of the button style flags. like, the flags said so, so the buttons happened. 💅

  • destroy(This :: wxPreviewControlBar()) -> ok.

Destroys the object. bye bestie 💀

  • getPrintPreview(This) -> wxPrintPreview:wxPrintPreview() when This :: wxPreviewControlBar().

Gets the print preview object associated with the control bar. the control bar's +1, basically. 🫶

  • getZoomControl(This) -> integer() when This :: wxPreviewControlBar().

Gets the current zoom setting in percent. number go brrr. 🔥

  • new(Preview, Buttons, Parent, [Option]) -> wxPreviewControlBar() when
Preview :: wxPrintPreview:wxPrintPreview(),
Buttons :: integer(),
Parent :: wxWindow:wxWindow(),
Option ::
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}.

Constructor. new instance just dropped 👑

The Buttons parameter may be a combination of the following, using the bitwise 'or' operator — yes, bitwise 'or', don't come for me, that's just how it is:

  • wxPREVIEW_PRINT: Create a print button. 🖨️
  • wxPREVIEW_NEXT: Create a next page button.
  • wxPREVIEW_PREVIOUS: Create a previous page button.
  • wxPREVIEW_ZOOM: Create a zoom control. 🔍
  • wxPREVIEW_DEFAULT: Equivalent to a combination of wxPREVIEW_PREVIOUS, wxPREVIEW_NEXT and wxPREVIEW_ZOOM. the bundle deal, the full set, the main character combo ✨
  • setZoomControl(This, Percent) -> ok when
This :: wxPreviewControlBar(),
Percent :: integer().

Sets the zoom control. you're in charge of the zoom now, congratulations. 🎉

ngl the wxPREVIEW_DEFAULT one is the move if you can't decide — it's literally wxPREVIEW_PREVIOUS + wxPREVIEW_NEXT + wxPREVIEW_ZOOM and it's giving "I didn't choose, I got the whole menu". no cap. 💖

and that's the page, bestie!! this lil beauty comes to you from Ericsson AB, sitting pretty at version wx 2.6, dated wxPreviewControlBar(3). go forth and preview responsibly 💅💖✨

📦 where this page comes from