Code::Blocks  SVN r11506
Public Types | Public Member Functions | Public Attributes | List of all members
CodeBlocksDockEvent Class Reference

Event used to request from the main app to add a window to the docking system. More...

#include <sdk_events.h>

Inheritance diagram for CodeBlocksDockEvent:
Collaboration diagram for CodeBlocksDockEvent:

Public Types

enum  DockSide {
  dsLeft = 0, dsRight, dsTop, dsBottom,
  dsFloating, dsUndefined
}
 

Public Member Functions

 CodeBlocksDockEvent (wxEventType commandType=wxEVT_NULL, int id=0)
 
 CodeBlocksDockEvent (const CodeBlocksDockEvent &rhs)
 
wxEventClone () const override
 

Public Attributes

wxString name
 Dock's name. Must be unique. If empty, a unique name will be assigned. More...
 
wxString title
 Dock's title. More...
 
wxWindowpWindow
 The window to dock. More...
 
wxSize desiredSize
 The desired size. More...
 
wxSize floatingSize
 The desired floating size. More...
 
wxSize minimumSize
 The minimum allowed size. More...
 
wxPoint floatingPos
 The desired floating position. More...
 
DockSide dockSide
 The side to dock it. More...
 
int row
 The row to dock it. More...
 
int column
 The column to dock it. More...
 
bool shown
 If true, initially shown. More...
 
bool stretch
 If true, the dock will stretch to fill the dockSide. More...
 
bool hideable
 If true, the dock will be allowed to be closed by the user. More...
 
bool asTab
 Add this window as a tab of an existing docked window (NOT IMPLEMENTED). More...
 
wxString bitmap
 The bitmap to use. More...
 
char padding [64]
 Unused space in this class for later enhancements. More...
 

Detailed Description

Event used to request from the main app to add a window to the docking system.

Definition at line 83 of file sdk_events.h.

Member Enumeration Documentation

◆ DockSide

Enumerator
dsLeft 
dsRight 
dsTop 
dsBottom 
dsFloating 
dsUndefined 

Definition at line 86 of file sdk_events.h.

Constructor & Destructor Documentation

◆ CodeBlocksDockEvent() [1/2]

CodeBlocksDockEvent::CodeBlocksDockEvent ( wxEventType  commandType = wxEVT_NULL,
int  id = 0 
)
inline

Definition at line 96 of file sdk_events.h.

◆ CodeBlocksDockEvent() [2/2]

CodeBlocksDockEvent::CodeBlocksDockEvent ( const CodeBlocksDockEvent rhs)
inline

Definition at line 114 of file sdk_events.h.

Member Function Documentation

◆ Clone()

wxEvent* CodeBlocksDockEvent::Clone ( ) const
inlineoverride

Definition at line 133 of file sdk_events.h.

Member Data Documentation

◆ asTab

bool CodeBlocksDockEvent::asTab

Add this window as a tab of an existing docked window (NOT IMPLEMENTED).

Definition at line 148 of file sdk_events.h.

◆ bitmap

wxString CodeBlocksDockEvent::bitmap

The bitmap to use.

Definition at line 149 of file sdk_events.h.

◆ column

int CodeBlocksDockEvent::column

The column to dock it.

Definition at line 144 of file sdk_events.h.

Referenced by MainFrame::OnRequestDockWindow().

◆ desiredSize

wxSize CodeBlocksDockEvent::desiredSize

◆ dockSide

DockSide CodeBlocksDockEvent::dockSide

◆ floatingPos

wxPoint CodeBlocksDockEvent::floatingPos

The desired floating position.

Definition at line 141 of file sdk_events.h.

Referenced by MainFrame::OnRequestDockWindow().

◆ floatingSize

wxSize CodeBlocksDockEvent::floatingSize

◆ hideable

bool CodeBlocksDockEvent::hideable

If true, the dock will be allowed to be closed by the user.

Definition at line 147 of file sdk_events.h.

Referenced by NativeParser::CreateClassBrowser(), and MainFrame::OnRequestDockWindow().

◆ minimumSize

wxSize CodeBlocksDockEvent::minimumSize

◆ name

wxString CodeBlocksDockEvent::name

◆ padding

char CodeBlocksDockEvent::padding[64]

Unused space in this class for later enhancements.

Definition at line 151 of file sdk_events.h.

◆ pWindow

wxWindow* CodeBlocksDockEvent::pWindow

◆ row

int CodeBlocksDockEvent::row

The row to dock it.

Definition at line 143 of file sdk_events.h.

Referenced by MainFrame::OnRequestDockWindow().

◆ shown

bool CodeBlocksDockEvent::shown

If true, initially shown.

Definition at line 145 of file sdk_events.h.

Referenced by NativeParser::CreateClassBrowser(), and MainFrame::OnRequestDockWindow().

◆ stretch

bool CodeBlocksDockEvent::stretch

If true, the dock will stretch to fill the dockSide.

Definition at line 146 of file sdk_events.h.

Referenced by MainFrame::OnRequestDockWindow().

◆ title

wxString CodeBlocksDockEvent::title

The documentation for this class was generated from the following file: