Padre-Plugin-WxWidgets

 view release on metacpan or  search on metacpan

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

   void SetMask(wxMask* mask)

   Sets the mask for this bitmap.

   Remarks

   The bitmap object owns the mask once this has been called.

   See also

   wxBitmap::GetMask, wxMask

=head2 Wx::Bitmap::SetPalette

   void SetPalette(const wxPalette& palette)

   Sets the associated palette. (Not implemented under GTK+).

   Parameters

   palette

       The palette to set.

   See also

   wxPalette

=head2 Wx::Bitmap::SetWidth

   void SetWidth(int width)

   Sets the width member (does not affect the bitmap data).

   Parameters

   width

       Bitmap width in pixels.

=head1 Wx::BitmapComboBox

=head2 Wx::BitmapComboBox::new

   wxBitmapComboBox()

   Default constructor.

   wxBitmapComboBox(wxWindow* parent, wxWindowID id, const wxString&
   value = "", const wxPoint& pos = wxDefaultPosition, const wxSize& size
   = wxDefaultSize, int n = 0, const wxString choices[] = NULL, long
   style = 0, const wxValidator& validator = wxDefaultValidator, const
   wxString& name = "comboBox")

   wxBitmapComboBox(wxWindow* parent, wxWindowID id, const wxString&
   value, const wxPoint& pos, const wxSize& size, const wxArrayString&
   choices, long style = 0, const wxValidator& validator =
   wxDefaultValidator, const wxString& name = "comboBox")

   Constructor, creating and showing a combobox.

   Parameters

   parent

       Parent window. Must not be NULL.

   id  

       Window identifier. A value of -1 indicates a default value.

   value

       Initial selection string. An empty string indicates no selection.

   pos 

       Window position.

   size

       Window size. If the default size (-1, -1) is specified then the
       window is sized appropriately.

   n   

       Number of strings with which to initialise the control.

   choices

       An array of strings with which to initialise the control.

   style

       Window style. See wxBitmapComboBox.

   validator

       Window validator.

   name

       Window name.

   See also

   wxBitmapComboBox::Create, wxValidator

=head2 Wx::BitmapComboBox::DESTROY

   ~wxBitmapComboBox()

   Destructor, destroying the combobox.

=head2 Wx::BitmapComboBox::Create

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value =
   "", const wxPoint& pos = wxDefaultPosition, const wxSize& size =
   wxDefaultSize, int n, const wxString choices[], long style = 0, const
   wxValidator& validator = wxDefaultValidator, const wxString& name =
   "comboBox")

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value,
   const wxPoint& pos, const wxSize& size, const wxArrayString& choices,
   long style = 0, const wxValidator& validator = wxDefaultValidator,
   const wxString& name = "comboBox")

   Creates the combobox for two-step construction. Derived classes should
   call or replace this function. See wxBitmapComboBox::wxBitmapComboBox
   for further details.

=head2 Wx::BitmapComboBox::Append

   int Append(const wxString& item, const wxBitmap& bitmap = wxNullBitmap)

   Adds the item to the end of the combo box.

   int Append(const wxString& item, const wxBitmap& bitmap, void *clientData)

   int Append(const wxString& item, const wxBitmap& bitmap, wxClientData
   *clientData)

   Adds the item to the end of the combo box, associating the given,
   typed or untyped, client data pointer with the item.

=head2 Wx::BitmapComboBox::GetBitmapSize

   wxSize GetBitmapSize() const

   Returns size of bitmaps used in the list.

=head2 Wx::BitmapComboBox::GetItemBitmap

   wxBitmap GetItemBitmap(unsigned int n) const

   Returns the bitmap of the item with the given index.

=head2 Wx::BitmapComboBox::Insert

   int Insert(const wxString& item, const wxBitmap& bitmap, unsigned int
   pos)

   Inserts the item into the list before pos. Not valid for wxCB_SORT
   style, use Append instead.

   int Insert(const wxString& item, const wxBitmap& bitmap, unsigned int
   pos, void *clientData)

   int Insert(const wxString& item, const wxBitmap& bitmap, unsigned int
   pos, wxClientData *clientData)

   Inserts the item into the list before pos, associating the given,
   typed or untyped, client data pointer with the item. Not valid for
   wxCB_SORT style, use Append instead.

=head2 Wx::BitmapComboBox::SetItemBitmap

   void SetItemBitmap(unsigned int n, const wxBitmap& bitmap)

   Sets the bitmap for the given item.

=head1 Wx::BitmapButton

=head2 Wx::BitmapButton::new

   wxBitmapButton()

   Default constructor.

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

   Return value

   true if the control was successfully created or false if creation
   failed.

=head2 Wx::ColourPickerCtrl::GetColour

   wxColour GetColour() const

   Returns the currently selected colour.

=head2 Wx::ColourPickerCtrl::SetColour

   void SetColour(const wxColour &col)

   void SetColour(const wxString &colname)

   Sets the currently selected colour. See wxColour::Set.

=head1 Wx::ColourPickerEvent

=head2 Wx::ColourPickerEvent::new

   wxColourPickerEvent(wxObject * generator, int id, const wxColour&
   colour)

   The constructor is not normally used by the user code.

=head2 Wx::ColourPickerEvent::GetColour

   wxColour GetColour() const

   Retrieve the colour the user has just selected.

=head2 Wx::ColourPickerEvent::SetColour

   void SetColour(const wxColour &pos)

   Set the colour associated with the event.

=head1 Wx::ComboBox

=head2 Wx::ComboBox::new

   wxComboBox()

   Default constructor.

   wxComboBox(wxWindow* parent, wxWindowID id, const wxString& value = "",
   const wxPoint& pos = wxDefaultPosition, const wxSize& size =
   wxDefaultSize, int n = 0, const wxString choices[] = NULL, long style
   = 0, const wxValidator& validator = wxDefaultValidator, const wxString&
   name = "comboBox")

   wxComboBox(wxWindow* parent, wxWindowID id, const wxString& value,
   const wxPoint& pos, const wxSize& size, const wxArrayString& choices,
   long style = 0, const wxValidator& validator = wxDefaultValidator,
   const wxString& name = "comboBox")

   Constructor, creating and showing a combobox.

   Parameters

   parent

       Parent window. Must not be NULL.

   id  

       Window identifier. A value of -1 indicates a default value.

   value

       Initial selection string. An empty string indicates no selection.

   pos 

       Window position.

   size

       Window size. If the default size (-1, -1) is specified then the
       window is sized appropriately.

   n   

       Number of strings with which to initialise the control.

   choices

       An array of strings with which to initialise the control.

   style

       Window style. See wxComboBox.

   validator

       Window validator.

   name

       Window name.

   See also

   wxComboBox::Create, wxValidator

   wxPython note: The wxComboBox constructor in wxPython reduces the n
   and choices arguments are to a single argument, which is a list of
   strings.

   wxPerl note: In wxPerl there is just an array reference in place of n
   and choices.

=head2 Wx::ComboBox::DESTROY

   ~wxComboBox()

   Destructor, destroying the combobox.

=head2 Wx::ComboBox::Create

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value =
   "", const wxPoint& pos = wxDefaultPosition, const wxSize& size =
   wxDefaultSize, int n, const wxString choices[], long style = 0, const
   wxValidator& validator = wxDefaultValidator, const wxString& name =
   "comboBox")

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value,
   const wxPoint& pos, const wxSize& size, const wxArrayString& choices,
   long style = 0, const wxValidator& validator = wxDefaultValidator,
   const wxString& name = "comboBox")

   Creates the combobox for two-step construction. Derived classes should
   call or replace this function. See wxComboBox::wxComboBox for further
   details.

=head2 Wx::ComboBox::CanCopy

   bool CanCopy() const

   Returns true if the combobox is editable and there is a text selection
   to copy to the clipboard. Only available on Windows.

=head2 Wx::ComboBox::CanCut

   bool CanCut() const

   Returns true if the combobox is editable and there is a text selection
   to copy to the clipboard. Only available on Windows.

=head2 Wx::ComboBox::CanPaste

   bool CanPaste() const

   Returns true if the combobox is editable and there is text on the
   clipboard that can be pasted into the text field. Only available on
   Windows.

=head2 Wx::ComboBox::CanRedo

   bool CanRedo() const

   Returns true if the combobox is editable and the last undo can be
   redone. Only available on Windows.

=head2 Wx::ComboBox::CanUndo

   bool CanUndo() const

   Returns true if the combobox is editable and the last edit can be
   undone. Only available on Windows.

=head2 Wx::ComboBox::Copy

   void Copy()

   Copies the selected text to the clipboard.

=head2 Wx::ComboBox::Cut

   void Cut()

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

=head2 Wx::ComboBox::GetCurrentSelection

   int GetCurrentSelection() const

   This function does the same things as wxChoice::GetCurrentSelection
   and returns the item currently selected in the dropdown list if it's
   open or the same thing as GetSelection otherwise.

=head2 Wx::ComboBox::GetInsertionPoint

   long GetInsertionPoint() const

   Returns the insertion point for the combobox's text field.

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

=head2 Wx::ComboBox::GetLastPosition

   virtual wxTextPos GetLastPosition() const

   Returns the last position in the combobox text field.

=head2 Wx::ComboBox::GetSelection

   void GetSelection(long *from, long *to) const

   This is the same as wxTextCtrl::GetSelection for the text control
   which is part of the combobox. Notice that this is a different method
   from wxControlWithItems::GetSelection.

   Currently this method is only implemented in wxMSW and wxGTK.

=head2 Wx::ComboBox::GetValue

   wxString GetValue() const

   Returns the current value in the combobox text field.

=head2 Wx::ComboBox::Paste

   void Paste()

   Pastes text from the clipboard to the text field.

=head2 Wx::ComboBox::Redo

   void Redo()

   Redoes the last undo in the text field. Windows only.

=head2 Wx::ComboBox::Replace

   void Replace(long from, long to, const wxString& text)

   Replaces the text between two positions with the given text, in the
   combobox text field.

   Parameters

   from

       The first position.

   to  

       The second position.

   text

       The text to insert.

=head2 Wx::ComboBox::Remove

   void Remove(long from, long to)

   Removes the text between the two positions in the combobox text field.

   Parameters

   from

       The first position.

   to  

       The last position.

=head2 Wx::ComboBox::SetInsertionPoint

   void SetInsertionPoint(long pos)

   Sets the insertion point in the combobox text field.

   Parameters

   pos 

       The new insertion point.

=head2 Wx::ComboBox::SetInsertionPointEnd

   void SetInsertionPointEnd()

   Sets the insertion point at the end of the combobox text field.

=head2 Wx::ComboBox::SetSelection

   void SetSelection(long from, long to)

   Selects the text between the two positions, in the combobox text
   field.

   Parameters

   from

       The first position.

   to  

       The second position.

   wxPython note: This method is called SetMark in wxPython, SetSelection
   name is kept for wxControlWithItems::SetSelection.

=head2 Wx::ComboBox::SetValue

   void SetValue(const wxString& text)

   Sets the text for the combobox text field.

   NB: For a combobox with wxCB_READONLY style the string must be in the
   combobox choices list, otherwise the call to SetValue() is ignored.

   Parameters

   text

       The text to set.

=head2 Wx::ComboBox::Undo

   void Undo()

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

=head1 Wx::ComboCtrl

=head2 Wx::ComboCtrl::new

   wxComboCtrl()

   Default constructor.

   wxComboCtrl(wxWindow* parent, wxWindowID id, const wxString& value =
   "", const wxPoint& pos = wxDefaultPosition, const wxSize& size =
   wxDefaultSize, long style = 0, const wxValidator& validator =
   wxDefaultValidator, const wxString& name = "comboCtrl")

   Constructor, creating and showing a combo control.

   Parameters

   parent

       Parent window. Must not be NULL.

   id  

       Window identifier. A value of -1 indicates a default value.

   value

       Initial selection string. An empty string indicates no selection.

   pos 

       Window position.

   size

       Window size. If the default size (-1, -1) is specified then the
       window is sized appropriately.

   style

       Window style. See wxComboCtrl.

   validator

       Window validator.

   name

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

   Decrements the reference count in the associated data, and if it is
   zero, deletes the data. The m_refData member is set to NULL.

   See also

   wxObject::Ref, wxObject::m_refData, wxObject::SetRefData,
   wxObject::GetRefData, wxObjectRefData

=head2 Wx::Object::UnShare

   void UnShare()

   Ensure that this object's data is not shared with any other object.

   if we have no data, it is created using CreateRefData() below, if we
   have shared data it is copied using CloneRefData(), otherwise nothing
   is done.

=head1 Wx::ObjectRefData

=head2 Wx::ObjectRefData::new

   wxObjectRefData()

   Default constructor. Initialises the m_count member to 1.

=head2 Wx::ObjectRefData::DESTROY

   wxObjectRefData()

   Destructor.

=head2 Wx::ObjectRefData::GetRefCount

   int GetRefCount() const

   Returns the reference count associated with this shared data. When
   this goes to zero during a wxObject::UnRef, an object can delete this
   wxObjectRefData object.

=head1 Wx::OwnerDrawnComboBox

=head2 Wx::OwnerDrawnComboBox::new

   wxOwnerDrawnComboBox()

   Default constructor.

   wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, const wxString&
   value = "", const wxPoint& pos = wxDefaultPosition, const wxSize& size
   = wxDefaultSize, int n = 0, const wxString choices[] = NULL, long
   style = 0, const wxValidator& validator = wxDefaultValidator, const
   wxString& name = "comboBox")

   wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, const wxString&
   value, const wxPoint& pos, const wxSize& size, const wxArrayString&
   choices, long style = 0, const wxValidator& validator =
   wxDefaultValidator, const wxString& name = "comboBox")

   Constructor, creating and showing a owner-drawn combobox.

   Parameters

   parent

       Parent window. Must not be NULL.

   id  

       Window identifier. A value of -1 indicates a default value.

   value

       Initial selection string. An empty string indicates no selection.

   pos 

       Window position.

   size

       Window size. If the default size (-1, -1) is specified then the
       window is sized appropriately.

   n   

       Number of strings with which to initialise the control.

   choices

       An array of strings with which to initialise the control.

   style

       Window style. See wxOwnerDrawnComboBox.

   validator

       Window validator.

   name

       Window name.

   See also

   wxOwnerDrawnComboBox::Create, wxValidator

=head2 Wx::OwnerDrawnComboBox::DESTROY

   ~wxOwnerDrawnComboBox()

   Destructor, destroying the owner-drawn combobox.

=head2 Wx::OwnerDrawnComboBox::Create

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value =
   "", const wxPoint& pos = wxDefaultPosition, const wxSize& size =
   wxDefaultSize, int n, const wxString choices[], long style = 0, const
   wxValidator& validator = wxDefaultValidator, const wxString& name =
   "comboBox")

   bool Create(wxWindow* parent, wxWindowID id, const wxString& value,
   const wxPoint& pos, const wxSize& size, const wxArrayString& choices,
   long style = 0, const wxValidator& validator = wxDefaultValidator,
   const wxString& name = "comboBox")

   Creates the combobox for two-step construction. Derived classes should
   call or replace this function. See
   wxOwnerDrawnComboBox::wxOwnerDrawnComboBox for further details.

=head2 Wx::OwnerDrawnComboBox::GetWidestItem

   int GetWidestItem() const

   Returns index to the widest item in the list.

=head2 Wx::OwnerDrawnComboBox::GetWidestItemWidth

   int GetWidestItemWidth() const

   Returns width of the widest item in the list.

=head2 Wx::OwnerDrawnComboBox::OnDrawBackground

   void OnDrawBackground(wxDC& dc, const wxRect& rect, int item, int
   flags) const

   This method is used to draw the items background and, maybe, a border
   around it.

   The base class version implements a reasonable default behaviour which
   consists in drawing the selected item with the standard background
   colour and drawing a border around the item if it is either selected
   or current.

   Remarks

   flags has the same meaning as with OnDrawItem.

=head2 Wx::OwnerDrawnComboBox::OnDrawItem

   void OnDrawItem(wxDC& dc, const wxRect& rect, int item, int flags)
   const

   The derived class may implement this function to actually draw the
   item with the given index on the provided DC. If function is not
   implemented, the item text is simply drawn, as if the control was a
   normal combobox.

   Parameters

   dc  

       The device context to use for drawing

   rect

       The bounding rectangle for the item being drawn (DC clipping
       region is set to this rectangle before calling this function)

   item

       The index of the item to be drawn

   flags

       Combines any of the following flag values:

=head2 Wx::OwnerDrawnComboBox::OnMeasureItem

   wxCoord OnMeasureItem(size_t item) const

   The derived class may implement this method to return the height of
   the specified item (in pixels).

   The default implementation returns text height, as if this control was
   a normal combobox.

=head2 Wx::OwnerDrawnComboBox::OnMeasureItemWidth

   wxCoord OnMeasureItemWidth(size_t item) const

   The derived class may implement this method to return the width of the
   specified item (in pixels). If -1 is returned, then the item text
   width is used.

   The default implementation returns -1.

=head1 Wx::OutputStream

=head2 Wx::OutputStream::new

   wxOutputStream()

   Creates a dummy wxOutputStream object.

=head2 Wx::OutputStream::DESTROY

   ~wxOutputStream()

   Destructor.

=head2 Wx::OutputStream::Close

   bool Close()

   Closes the stream, returning false if an error occurs. The stream is
   closed implicitly in the destructor if Close() is not called
   explicitly.

   If this stream wraps another stream or some other resource such as a
   file, then the underlying resource is closed too if it is owned by
   this stream, or left open otherwise.

=head2 Wx::OutputStream::LastWrite

   size_t LastWrite() const

   Returns the number of bytes written during the last Write(). It may
   return 0 even if there is no error on the stream if it is only
   temporarily impossible to write to it.

=head2 Wx::OutputStream::PutC

   void PutC(char c)

   Puts the specified character in the output queue and increments the
   stream position.

=head2 Wx::OutputStream::SeekO

   off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart)

   Changes the stream current position.

   Parameters

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

=head2 Wx::ToolBar::new

   wxToolBar()

   Default constructor.

   wxToolBar(wxWindow* parent, wxWindowID id, const wxPoint& pos =
   wxDefaultPosition, const wxSize& size = wxDefaultSize, long style =
   wxTB_HORIZONTAL | wxNO_BORDER, const wxString& name = wxPanelNameStr)

   Constructs a toolbar.

   Parameters

   parent

       Pointer to a parent window.

   id  

       Window identifier. If -1, will automatically create an identifier.

   pos 

       Window position. wxDefaultPosition is (-1, -1) which indicates
       that wxWidgets should generate a default position for the window.
       If using the wxWindow class directly, supply an actual position.

   size

       Window size. wxDefaultSize is (-1, -1) which indicates that
       wxWidgets should generate a default size for the window.

   style

       Window style. See wxToolBar for details.

   name

       Window name.

   Remarks

   After a toolbar is created, you use wxToolBar::AddTool and perhaps
   wxToolBar::AddSeparator, and then you must call wxToolBar::Realize to
   construct and display the toolbar tools.

   You may also create a toolbar that is managed by the frame, by calling
   wxFrame::CreateToolBar.

=head2 Wx::ToolBar::DESTROY

   void ~wxToolBar()

   Toolbar destructor.

=head2 Wx::ToolBar::AddControl

   bool AddControl(wxControl* control)

   Adds any control to the toolbar, typically e.g. a combobox.

   control

       The control to be added.

=head2 Wx::ToolBar::AddSeparator

   void AddSeparator()

   Adds a separator for spacing groups of tools.

   See also

   wxToolBar::AddTool, wxToolBar::SetToolSeparation

=head2 Wx::ToolBar::AddTool

   wxToolBarToolBase* AddTool(int toolId, const wxString& label, const
   wxBitmap& bitmap1, const wxString& shortHelpString = "", wxItemKind
   kind = wxITEM_NORMAL)

   wxToolBarToolBase* AddTool(int toolId, const wxString& label, const
   wxBitmap& bitmap1, const wxBitmap& bitmap2 = wxNullBitmap, wxItemKind
   kind = wxITEM_NORMAL, const wxString& shortHelpString = "", const
   wxString& longHelpString = "", wxObject* clientData = NULL)

   wxToolBarToolBase* AddTool(wxToolBarToolBase* tool)

   Adds a tool to the toolbar. The first (short and most commonly used)
   version has fewer parameters than the full version at the price of not
   being able to specify some of the more rarely used button features.
   The last version allows you to add an existing tool.

   Parameters

   toolId

       An integer by which the tool may be identified in subsequent
       operations.

   kind

       May be wxITEM_NORMAL for a normal button (default), wxITEM_CHECK
       for a checkable tool (such tool stays pressed after it had been
       toggled) or wxITEM_RADIO for a checkable tool which makes part of
       a radio group of tools each of which is automatically unchecked
       whenever another button in the group is checked

   bitmap1

       The primary tool bitmap.

   bitmap2

       The bitmap used when the tool is disabled. If it is equal to
       wxNullBitmap, the disabled bitmap is automatically generated by
       greing the normal one.

   shortHelpString