Padre-Plugin-WxWidgets

 view release on metacpan or  search on metacpan

share/doc/wxwidgets.pod  view on Meta::CPAN

   ~wxComboCtrl()

   Destructor, destroying the combo control.

=head2 Wx::ComboCtrl::AnimateShow

   virtual bool AnimateShow(const wxRect& rect, int flags)

   This member function is not normally called in application code.
   Instead, it can be implemented in a derived class to create a custom
   popup animation.

   Parameters

   Same as in DoShowPopup.

   Return value

   true if animation finishes before the function returns. false
   otherwise. In the latter case you need to manually call DoShowPopup
   after the animation ends.

share/doc/wxwidgets.pod  view on Meta::CPAN

   Copies the selected text to the clipboard.

=head2 Wx::ComboCtrl::Cut

   void Cut()

   Copies the selected text to the clipboard and removes the selection.

=head2 Wx::ComboCtrl::DoSetPopupControl

   void DoSetPopupControl(wxComboPopup* popup)

   This member function is not normally called in application code.
   Instead, it can be implemented in a derived class to return default
   wxComboPopup, incase popup is NULL.

   Note: If you have implemented OnButtonClick to do something else than
   show the popup, then DoSetPopupControl must always return NULL.

=head2 Wx::ComboCtrl::DoShowPopup

   virtual void DoShowPopup(const wxRect& rect, int flags)

   This member function is not normally called in application code.
   Instead, it must be called in a derived class to make sure popup is
   properly shown after a popup animation has finished (but only if
   AnimateShow did not finish the animation within it's function scope).

   Parameters

   rect

       Position to show the popup window at, in screen coordinates.

   flags

       Combination of any of the following:

=head2 Wx::ComboCtrl::EnablePopupAnimation

   void EnablePopupAnimation(bool enable = true)

   Enables or disables popup animation, if any, depending on the value of
   the argument.

=head2 Wx::ComboCtrl::GetBitmapDisabled

   const wxBitmap& GetBitmapDisabled() const

   Returns disabled button bitmap that has been set with SetButtonBitmaps.

   Return value

share/doc/wxwidgets.pod  view on Meta::CPAN

   Returns the insertion point for the combo control's text field.

   Note: Under wxMSW, this function always returns 0 if the combo control
   doesn't have the focus.

=head2 Wx::ComboCtrl::IsPopupWindowState

   bool IsPopupWindowState(int state) const

   Returns true if the popup window is in the given state. Possible
   values are:

=head2 Wx::ComboCtrl::GetLastPosition

   long GetLastPosition() const

   Returns the last position in the combo control text field.

=head2 Wx::ComboCtrl::GetPopupControl

   wxComboPopup* GetPopupControl()

   Returns current popup interface that has been set with
   SetPopupControl.

=head2 Wx::ComboCtrl::GetPopupWindow

   wxWindow* GetPopupWindow() const

   Returns popup window containing the popup control.

=head2 Wx::ComboCtrl::GetTextCtrl

   wxTextCtrl* GetTextCtrl() const

   Get the text control which is part of the combo control.

=head2 Wx::ComboCtrl::GetTextIndent

   wxCoord GetTextIndent() const

share/doc/wxwidgets.pod  view on Meta::CPAN

   wxString GetValue() const

   Returns text representation of the current value. For writable combo
   control it always returns the value in the text field.

=head2 Wx::ComboCtrl::HidePopup

   void HidePopup()

   Dismisses the popup window.

=head2 Wx::ComboCtrl::IsPopupShown

   bool IsPopupShown() const

   Returns true if the popup is currently shown

=head2 Wx::ComboCtrl::OnButtonClick

   void OnButtonClick()

   Implement in a derived class to define what happens on dropdown button
   click.

   Default action is to show the popup.

   Note: If you implement this to do something else than show the popup,
   you must then also implement DoSetPopupControl to always return NULL.

=head2 Wx::ComboCtrl::Paste

   void Paste()

   Pastes text from the clipboard to the text field.

=head2 Wx::ComboCtrl::Remove

share/doc/wxwidgets.pod  view on Meta::CPAN

=head2 Wx::ComboCtrl::SetInsertionPointEnd

   void SetInsertionPointEnd()

   Sets the insertion point at the end of the combo control text field.

=head2 Wx::ComboCtrl::SetPopupAnchor

   void SetPopupAnchor(int anchorSide)

   Set side of the control to which the popup will align itself. Valid
   values are wxLEFT, wxRIGHT and 0. The default value 0 means that the
   most appropriate side is used (which, currently, is always wxLEFT).

=head2 Wx::ComboCtrl::SetPopupControl

   void SetPopupControl(wxComboPopup* popup)

   Set popup interface class derived from wxComboPopup. This method
   should be called as soon as possible after the control has been
   created, unless OnButtonClick has been overridden.

=head2 Wx::ComboCtrl::SetPopupExtents

   void SetPopupExtents(int extLeft, int extRight)

   Extends popup size horizontally, relative to the edges of the combo
   control.

   Parameters

   extLeft

       How many pixel to extend beyond the left edge of the control.
       Default is 0.

=head2 Wx::ComboCtrl::SetPopupMaxHeight

   void SetPopupMaxHeight(int height)

   Sets preferred maximum height of the popup.

   Remarks

   Value -1 indicates the default.

   Also, popup implementation may choose to ignore this.

=head2 Wx::ComboCtrl::SetPopupMinWidth

   void SetPopupMinWidth(int width)

   Sets minimum width of the popup. If wider than combo control, it will
   extend to the left.

   Remarks

   Value -1 indicates the default.

   Also, popup implementation may choose to ignore this.

=head2 Wx::ComboCtrl::SetSelection

   void SetSelection(long from, long to)

   Selects the text between the two positions, in the combo control text
   field.

   Parameters

share/doc/wxwidgets.pod  view on Meta::CPAN

       The first position.

   to  

       The second position.

=head2 Wx::ComboCtrl::SetText

   void SetText(const wxString& value)

   Sets the text for the text field without affecting the popup. Thus,
   unlike SetValue, it works equally well with combo control using
   wxCB_READONLY style.

=head2 Wx::ComboCtrl::SetTextIndent

   void SetTextIndent(int indent)

   This will set the space in pixels between left edge of the control and
   the text, regardless whether control is read-only or not. Value -1 can
   be given to indicate platform default.

=head2 Wx::ComboCtrl::SetValue

   void SetValue(const wxString& value)

   Sets the text for the combo control text field.

   NB: For a combo control with wxCB_READONLY style the string must be
   accepted by the popup (for instance, exist in the dropdown list),
   otherwise the call to SetValue() is ignored

=head2 Wx::ComboCtrl::SetValueWithEvent

   void SetValueWithEvent(const wxString& value, bool withEvent = true)

   Same as SetValue, but also sends wxCommandEvent of type
   wxEVT_COMMAND_TEXT_UPDATED if withEvent is true.

=head2 Wx::ComboCtrl::ShowPopup

   void ShowPopup()

   Show the popup.

=head2 Wx::ComboCtrl::Undo

   void Undo()

   Undoes the last edit in the text field. Windows only.

=head2 Wx::ComboCtrl::UseAltPopupWindow

   void UseAltPopupWindow(bool enable = true)

   Enable or disable usage of an alternative popup window, which
   guarantees ability to focus the popup control, and allows common
   native controls to function normally. This alternative popup window is
   usually a wxDialog, and as such, when it is shown, its parent
   top-level window will appear as if the focus has been lost from it.

=head1 Wx::ComboPopup

=head2 Wx::ComboPopup::new

   wxComboPopup()

   Default constructor. It is recommended that internal variables are

share/doc/wxwidgets.pod  view on Meta::CPAN

   wxComboCtrl* m_combo

   Parent wxComboCtrl. This protected member variable is prepared
   automatically before Init is called.

=head2 Wx::ComboPopup::Create

   bool Create(wxWindow* parent)

   The derived class must implement this to create the popup control.

   Return value

   true if the call succeeded, false otherwise.

=head2 Wx::ComboPopup::Dismiss

   void Dismiss()

   Utility function that hides the popup.

=head2 Wx::ComboPopup::GetAdjustedSize

   wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight)

   The derived class may implement this to return adjusted size for the
   popup control, according to the variables given.

   Parameters

   minWidth

       Preferred minimum width.

=head2 Wx::ComboPopup::GetControl

   wxWindow* GetControl()

share/doc/wxwidgets.pod  view on Meta::CPAN

   Utility method that returns true if Create has been called.

   Useful in conjunction with LazyCreate.

=head2 Wx::ComboPopup::LazyCreate

   bool LazyCreate()

   The derived class may implement this to return true if it wants to
   delay call to Create until the popup is shown for the first time. It
   is more efficient, but on the other hand it is often more convenient
   to have the control created immediately.

   Remarks

   Base implementation returns false.

=head2 Wx::ComboPopup::OnComboDoubleClick

   void OnComboDoubleClick()

share/doc/wxwidgets.pod  view on Meta::CPAN

   The derived class may implement this to receive key events from the
   parent wxComboCtrl.

   Events not handled should be skipped, as usual.

=head2 Wx::ComboPopup::OnDismiss

   void OnDismiss()

   The derived class may implement this to do special processing when
   popup is hidden.

=head2 Wx::ComboPopup::OnPopup

   void OnPopup()

   The derived class may implement this to do special processing when
   popup is shown.

=head2 Wx::ComboPopup::PaintComboControl

   void PaintComboControl(wxDC& dc, const wxRect& rect)

   The derived class may implement this to paint the parent wxComboCtrl.

   Default implementation draws value as string.

=head2 Wx::ComboPopup::SetStringValue

share/doc/wxwidgets.pod  view on Meta::CPAN

=head2 Wx::HelpController::DisplayContents

   virtual bool DisplayContents()

   If the help viewer is not running, runs it and displays the contents.

=head2 Wx::HelpController::DisplayContextPopup

   virtual bool DisplayContextPopup(int contextId)

   Displays the section as a popup window using a context id.

   Returns false if unsuccessful or not implemented.

=head2 Wx::HelpController::DisplaySection

   virtual bool DisplaySection(const wxString& section)

   If the help viewer is not running, runs it and displays the given
   section.

share/doc/wxwidgets.pod  view on Meta::CPAN

   wxHtmlHelpController: sectionNo is an identifier as specified in the
   .hhc file. See Help files format.

   See also the help sample for notes on how to specify section numbers
   for various help file formats.

=head2 Wx::HelpController::DisplayTextPopup

   virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos)

   Displays the text in a popup window, if possible.

   Returns false if unsuccessful or not implemented.

=head2 Wx::HelpController::GetFrameParameters

   virtual wxFrame * GetFrameParameters(const wxSize * size = NULL, const
   wxPoint * pos = NULL, bool *newFrameEachTime = NULL)

   wxHtmlHelpController returns the frame, size and position.

share/doc/wxwidgets.pod  view on Meta::CPAN

=head2 Wx::Menu::new

   wxMenu(const wxString& title = "", long style = 0)

   Constructs a wxMenu object.

   Parameters

   title

       A title for the popup menu: the empty string denotes no title.

   style

       If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK
       only).

   wxMenu(long style)

   Constructs a wxMenu object.

share/doc/wxwidgets.pod  view on Meta::CPAN

       If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK
       only).

=head2 Wx::Menu::DESTROY

   ~wxMenu()

   Destructor, destroying the menu.

   Note: under Motif, a popup menu must have a valid parent (the window
   it was last popped up on) when being destroyed. Therefore, make sure
   you delete or re-use the popup menu before destroying the parent
   window. Re-use in this context means popping up the menu on a
   different window from last time, which causes an implicit destruction
   and recreation of internal data structures.

=head2 Wx::Menu::Append

   wxMenuItem* Append(int id, const wxString& item = "", const wxString&
   helpString = "", wxItemKind kind = wxITEM_NORMAL)

   Adds a string item to the end of the menu.

share/doc/wxwidgets.pod  view on Meta::CPAN

   pseudo-template list class containing wxMenuItem pointers, see wxList.

=head2 Wx::Menu::GetTitle

   wxString GetTitle() const

   Returns the title of the menu.

   Remarks

   This is relevant only to popup menus, use wxMenuBar::GetMenuLabel for
   the menus in the menubar.

   See also

   wxMenu::SetTitle

=head2 Wx::Menu::Insert

   wxMenuItem* Insert(size_t pos, wxMenuItem *item)

share/doc/wxwidgets.pod  view on Meta::CPAN

   Sets the title of the menu.

   Parameters

   title

       The title to set.

   Remarks

   This is relevant only to popup menus, use wxMenuBar::SetLabelTop for
   the menus in the menubar.

   See also

   wxMenu::GetTitle

=head2 Wx::Menu::UpdateUI

   void UpdateUI(wxEvtHandler* source = NULL) const

share/doc/wxwidgets.pod  view on Meta::CPAN

   int GetMenuId() const

   Returns the menu identifier associated with the event. This method
   should be only used with the HIGHLIGHT events.

=head2 Wx::MenuEvent::IsPopup

   bool IsPopup() const

   Returns true if the menu which is being opened or closed is a popup
   menu, false if it is a normal one.

   This method should only be used with the OPEN and CLOSE events.

=head1 Wx::MenuItem

=head2 Wx::MenuItem::new

   wxMenuItem(wxMenu* parentMenu = NULL, int id = wxID_SEPARATOR, const
   wxString& text = "", const wxString& helpString = "", wxItemKind kind

share/doc/wxwidgets.pod  view on Meta::CPAN

   ~wxTaskBarIcon()

   Destroys the wxTaskBarIcon object, removing the icon if not already
   removed.

=head2 Wx::TaskBarIcon::CreatePopupMenu

   virtual wxMenu* CreatePopupMenu()

   This method is called by the library when the user requests popup menu
   (on Windows and Unix platforms, this is when the user right-clicks the
   icon). Override this function in order to provide popup menu
   associated with the icon.

   If CreatePopupMenu returns NULL (this happens by default), no menu is
   shown, otherwise the menu is displayed and then deleted by the library
   as soon as the user dismisses it. The events can be handled by a class
   derived from wxTaskBarIcon.

=head2 Wx::TaskBarIcon::IsIconInstalled

   bool IsIconInstalled()