Padre-Plugin-WxWidgets

 view release on metacpan or  search on metacpan

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

=head2 Wx::Clipboard::DESTROY

   ~wxClipboard()

   Destructor.

=head2 Wx::Clipboard::AddData

   bool AddData(wxDataObject* data)

   Call this function to add the data object to the clipboard. You may
   call this function repeatedly after having cleared the clipboard using
   wxClipboard::Clear.

   After this function has been called, the clipboard owns the data, so
   do not delete the data explicitly.

   See also

   wxClipboard::SetData

=head2 Wx::Clipboard::Clear

   void Clear()

   Clears the global clipboard object and the system's clipboard if
   possible.

=head2 Wx::Clipboard::Close

   void Close()

   Call this function to close the clipboard, having opened it with
   wxClipboard::Open.

=head2 Wx::Clipboard::Flush

   bool Flush()

   Flushes the clipboard: this means that the data which is currently on
   clipboard will stay available even after the application exits
   (possibly eating memory), otherwise the clipboard will be emptied on
   exit. Returns false if the operation is unsuccessful for any reason.

=head2 Wx::Clipboard::GetData

   bool GetData(wxDataObject& data)

   Call this function to fill data with data on the clipboard, if
   available in the required format. Returns true on success.

=head2 Wx::Clipboard::IsOpened

   bool IsOpened() const

   Returns true if the clipboard has been opened.

=head2 Wx::Clipboard::IsSupported

   bool IsSupported(const wxDataFormat& format)

   Returns true if there is data which matches the data format of the
   given data object currently available (IsSupported sounds like a
   misnomer, FIXME: better deprecate this name?) on the clipboard.

=head2 Wx::Clipboard::Open

   bool Open()

   Call this function to open the clipboard before calling
   wxClipboard::SetData and wxClipboard::GetData.

   Call wxClipboard::Close when you have finished with the clipboard. You
   should keep the clipboard open for only a very short time.

   Returns true on success. This should be tested (as in the sample shown
   above).

=head2 Wx::Clipboard::SetData

   bool SetData(wxDataObject* data)

   Call this function to set the data object to the clipboard. This
   function will clear all previous contents in the clipboard, so calling
   it several times does not make any sense.

   After this function has been called, the clipboard owns the data, so
   do not delete the data explicitly.

   See also

   wxClipboard::AddData

=head2 Wx::Clipboard::UsePrimarySelection

   void UsePrimarySelection(bool primary = true)

   On platforms supporting it (currently only GTK), selects the so called
   PRIMARY SELECTION as the clipboard as opposed to the normal clipboard,
   if primary is true.

=head1 Wx::ClipboardTextEvent

=head2 Wx::ClipboardTextEvent::new

   wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0)

=head1 Wx::CloseEvent

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

   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

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

=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)

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

   wxDefaultValidator, const wxString& name = "comboCtrl")

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

=head2 Wx::ComboCtrl::Copy

   void Copy()

   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

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

   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

   void Remove(long from, long to)

   Removes the text between the two positions in the combo control text
   field.

   Parameters

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

   Adds the dataObject to the list of supported objects and it becomes
   the preferred object if preferred is true.

=head2 Wx::DataObjectComposite::GetReceivedFormat

   wxDataFormat GetReceivedFormat() const

   Report the format passed to the SetData method. This should be the
   format of the data object within the composite that recieved data from
   the clipboard or the DnD operation. You can use this method to find
   out what kind of data object was recieved.

=head1 Wx::DataObjectSimple

=head2 Wx::DataObjectSimple::new

   wxDataObjectSimple(const wxDataFormat& format = wxFormatInvalid)

   Constructor accepts the supported format (none by default) which may
   also be set later with SetFormat.

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

   bool Play(wxDC *dc)

   Plays the metafile into the given device context, returning true if
   successful.

=head2 Wx::Metafile::SetClipboard

   bool SetClipboard(int width = 0, int height = 0)

   Passes the metafile data to the clipboard. The metafile can no longer
   be used for anything, but the wxMetafile object must still be
   destroyed by the application.

   Below is a example of metafile, metafile device context and clipboard
   use from the hello.cpp example. Note the way the metafile dimensions
   are passed to the clipboard, making use of the device context's
   ability to keep track of the maximum extent of drawing commands.

     wxMetafileDC dc;
     if (dc.Ok())
     {
       Draw(dc, false);
       wxMetafile *mf = dc.Close();
       if (mf)
       {
         bool success = mf->SetClipboard((int)(dc.MaxX() + 10), (int)(dc.MaxY() + 10));

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

   wxEmptyString)

   Begins applying wxTEXT_ATTR_URL to the content. Pass a URL and
   optionally, a character style to apply, since it is common to mark a
   URL with a familiar style such as blue text with underlining.

=head2 Wx::RichTextBuffer::CanPasteFromClipboard

   bool CanPasteFromClipboard() const

   Returns true if content can be pasted from the clipboard.

=head2 Wx::RichTextBuffer::CleanUpHandlers

   void CleanUpHandlers()

   Cleans up the file handlers.

=head2 Wx::RichTextBuffer::Clear

   void Clear()

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

=head2 Wx::RichTextBuffer::Copy

   void Copy(const wxRichTextBuffer& obj)

   Copies the given buffer.

=head2 Wx::RichTextBuffer::CopyToClipboard

   bool CopyToClipboard(const wxRichTextRange& range)

   Copy the given range to the clipboard.

=head2 Wx::RichTextBuffer::DeleteRangeWithUndo

   bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl*
   ctrl)

   Submits a command to delete the given range.

=head2 Wx::RichTextBuffer::Dump

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

   Numbers the paragraphs in the given range. Pass flags to determine how
   the attributes are set. Either the style definition or the name of the
   style definition (in the current sheet) can be passed.

   flags is a bit list of the following:

=head2 Wx::RichTextBuffer::PasteFromClipboard

   bool PasteFromClipboard(long position)

   Pastes the clipboard content to the buffer at the given position.

=head2 Wx::RichTextBuffer::PromoteList

   bool PromoteList(int promoteBy, const wxRichTextRange& range, const
   wxRichTextListStyleDefinition* style, int flags =
   wxRICHTEXT_SETSTYLE_WITH_UNDO, int listLevel = -1)

   bool PromoteList(int promoteBy, const wxRichTextRange& range, const
   wxString& styleName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int
   listLevel = -1)

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

   wxEmptyString)

   Begins applying wxTEXT_ATTR_URL to the content. Pass a URL and
   optionally, a character style to apply, since it is common to mark a
   URL with a familiar style such as blue text with underlining.

=head2 Wx::RichTextCtrl::CanCopy

   bool CanCopy() const

   Returns true if selected content can be copied to the clipboard.

=head2 Wx::RichTextCtrl::CanCut

   bool CanCut() const

   Returns true if selected content can be copied to the clipboard and
   deleted.

=head2 Wx::RichTextCtrl::CanDeleteSelection

   bool CanDeleteSelection() const

   Returns true if selected content can be deleted.

=head2 Wx::RichTextCtrl::CanPaste

   bool CanPaste() const

   Returns true if the clipboard content can be pasted to the buffer.

=head2 Wx::RichTextCtrl::CanRedo

   bool CanRedo() const

   Returns true if there is a command in the command history that can be
   redone.

=head2 Wx::RichTextCtrl::CanUndo

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

=head2 Wx::RichTextCtrl::Command

   void Command(wxCommandEvent& event)

   Sends the event to the control.

=head2 Wx::RichTextCtrl::Copy

   void Copy()

   Copies the selected content (if any) to the clipboard.

=head2 Wx::RichTextCtrl::Create

   bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxString&
   value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const
   wxSize& size = wxDefaultSize, long style = wxRE_MULTILINE, const
   wxValidator& validator = wxDefaultValidator, const wxString& name =
   wxTextCtrlNameStr)

   Creates the underlying window.

=head2 Wx::RichTextCtrl::Cut

   void Cut()

   Copies the selected content (if any) to the clipboard and deletes the
   selection. This is undoable.

=head2 Wx::RichTextCtrl::Delete

   bool Delete(const wxRichTextRange& range)

   Deletes the content within the given range.

=head2 Wx::RichTextCtrl::DeleteSelectedContent

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

=head2 Wx::RichTextCtrl::PaintBackground

   void PaintBackground(wxDC& dc)

   Paints the background.

=head2 Wx::RichTextCtrl::Paste

   void Paste()

   Pastes content from the clipboard to the buffer.

=head2 Wx::RichTextCtrl::PositionCaret

   void PositionCaret()

   Internal function to position the visible caret according to the
   current caret position.

=head2 Wx::RichTextCtrl::PositionToXY

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

   should use GetInsertionPoint and SetInsertionPoint.

   See also

   wxTextCtrl::WriteText

=head2 Wx::TextCtrl::CanCopy

   virtual bool CanCopy()

   Returns true if the selection can be copied to the clipboard.

=head2 Wx::TextCtrl::CanCut

   virtual bool CanCut()

   Returns true if the selection can be cut to the clipboard.

=head2 Wx::TextCtrl::CanPaste

   virtual bool CanPaste()

   Returns true if the contents of the clipboard can be pasted into the
   text control. On some platforms (Motif, GTK) this is an approximation
   and returns true if the control is editable, false otherwise.

=head2 Wx::TextCtrl::CanRedo

   virtual bool CanRedo()

   Returns true if there is a redo facility available and the last
   operation can be redone.

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

   Clears the text in the control.

   Note that this function will generate a wxEVT_COMMAND_TEXT_UPDATED
   event.

=head2 Wx::TextCtrl::Copy

   virtual void Copy()

   Copies the selected text to the clipboard under Motif and MS Windows.

=head2 Wx::TextCtrl::Create

   bool Create(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 = wxTextCtrlNameStr)

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

=head2 Wx::TextCtrl::Cut

   virtual void Cut()

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

=head2 Wx::TextCtrl::DiscardEdits

   void DiscardEdits()

   Resets the internal 'modified' flag as if the current edits had been
   saved.

=head2 Wx::TextCtrl::EmulateKeyPress

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

   This is not implemented on non-Windows platforms.

   See also

   wxDropFilesEvent

=head2 Wx::TextCtrl::Paste

   virtual void Paste()

   Pastes text from the clipboard to the text item.

=head2 Wx::TextCtrl::PositionToXY

   bool PositionToXY(long pos, long *x, long *y) const

   Converts given position to a zero-based column, line number pair.

   Parameters

   pos